#5303 Document that plugins don't raise exception in all errors cases
Opened 8 years ago by cheimes. Modified 5 years ago

From the documentation it is not immediately obvious that some error cases don't raise an exception. Instead the problem is reported in the return value. It's usually the case when a plugin can change multiple things (e.g. add a user to multiple groups) and some changes can be fulfilled.

The documentation should point out when a plugin signals a problem in the return value of an API call.

Related to #5242


Metadata Update from @cheimes:
- Issue assigned to someone
- Issue set to the milestone: FreeIPA 4.5 backlog

7 years ago

Can you expand on this? What documentation?

Metadata Update from @rcritten:
- Issue close_status updated to: None

5 years ago

I guess we don't have any official, public documentation for the Python API yet, because it's not considered as a public API. It's for the hypothetical case that the API well get documentation some time in the future.

Metadata Update from @cheimes:
- Issue set to the milestone: Future Releases (was: FreeIPA 4.5 backlog)

5 years ago

Metadata Update from @rcritten:
- Issue tagged with: documentation

5 years ago

Log in to comment on this ticket.

Metadata