Add docstrings to api modules in apptools subpackages#274
Conversation
modified: apptools/io/api.py modified: apptools/logger/api.py modified: apptools/naming/api.py modified: apptools/naming/trait_defs/api.py modified: apptools/preferences/api.py modified: apptools/preferences/ui/api.py modified: apptools/scripting/api.py modified: apptools/selection/api.py modified: apptools/type_registry/api.py modified: apptools/undo/action/api.py modified: apptools/undo/api.py
new file: docs/releases/upcoming/274.doc.rst
aaronayres35
left a comment
aaronayres35
left a comment
There was a problem hiding this comment.
Changes LGTM
One thing I noticed though (This is probably already known), is that when you navigate to the page for one of the api modules rather than just seeing links to the docs for the objects you get the api docs directly on that page. In other words, the full contents for the docs of the apptools.naming package are on one page. Consider this example from envisage:
Whereas in apptools we have:
Notice the section for apptools.naming.binding module at the bottom of the screenshot. There are sections for the other naming submodules as well all on this same page.
This may be intentional / unrelated to the changes of this PR so feel free to ignore, but I wanted to make sure it was pointed out
Yup. This is because of the recent change where we use templates when building docs. |
2 participants
This PR adds module docstrings to all api modules in the various apptools subpackages.
Checklist