-
Notifications
You must be signed in to change notification settings - Fork 4.6k
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.
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
[Pythonclient] Add missing docstrings #2565
Conversation
As a side note, many PR's Travis status are not being updated, might be due to https://travis-ci.community/t/github-status-not-posted-on-commits-on-repositories-using-legacy-service-integration/7798 |
ca73417
to
2a48aa7
Compare
Also, would be great to have a proper list of APIs auto-generated and added to the Wiki, that'll make things much easier. What should be used for that, Sphinx, pdoc, or something else? |
bb9681b
to
66768b7
Compare
7aab18b
to
c91ca99
Compare
I've added a first version of sphynx doc generator. I'll do the next step soon: call |
Need to add docstring for all the APIs to make it appear on the list, which is quite painful 😅 Well, just add One final thing which would be very useful is to automate the entire doc build, rather than require a manual update. Having outdated and conflicting info causes issues, and manual update each small change in a PR takes up valuable time of the maintainers |
2ad3215
to
f4f3d53
Compare
I've made a new PR #2599 while has some fixes noticed while working on this PR Only some MoveBy APIs remaining. Note that I haven't personally tested all the APIs |
9a92293
to
621fed9
Compare
List members without docstrings also, add viewcode extension
WIP