-
-
Notifications
You must be signed in to change notification settings - Fork 14
Improve documentation #74
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
The documentation still has a few phrases that are left from a previous version of the
Effectapi. While not strictly incorrect, they can be made more clear.Moreover, the
pytkdocswheel used to collect api documentation doesn't collect accurate api documentation in all cases for the cython code. A cythonmkdocstringshandler should be implemented that collects accurate information.