Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation #74

Open
suned opened this issue Apr 5, 2021 · 0 comments
Open

Improve documentation #74

suned opened this issue Apr 5, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@suned
Copy link
Owner

suned commented Apr 5, 2021

The documentation still has a few phrases that are left from a previous version of the Effect api. While not strictly incorrect, they can be made more clear.

Moreover, the pytkdocs wheel used to collect api documentation doesn't collect accurate api documentation in all cases for the cython code. A cython mkdocstrings handler should be implemented that collects accurate information.
@suned suned added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@suned