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

[Pythonclient] Add missing docstrings #2565

Merged
merged 3 commits into from
Apr 29, 2020
Merged

[Pythonclient] Add missing docstrings #2565

merged 3 commits into from
Apr 29, 2020

Conversation

rajat2004
Copy link
Contributor

WIP

@rajat2004
Copy link
Contributor Author

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

@rajat2004 rajat2004 force-pushed the api-docs branch 2 times, most recently from ca73417 to 2a48aa7 Compare April 12, 2020 13:29
@rajat2004
Copy link
Contributor Author

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?

@rajat2004 rajat2004 force-pushed the api-docs branch 2 times, most recently from bb9681b to 66768b7 Compare April 12, 2020 18:21
@rajat2004 rajat2004 changed the title [docs] Add missing docstrings [Pythonclient] Add missing docstrings Apr 14, 2020
@rajat2004 rajat2004 force-pushed the api-docs branch 4 times, most recently from 7aab18b to c91ca99 Compare April 14, 2020 17:34
@madratman
Copy link
Contributor

I've added a first version of sphynx doc generator. I'll do the next step soon: call build_api_docs.sh from build_docs.sh; copy sphynx html to gh-pages and rename it to api.html; and then finally we need a little button on main github.io site to link to API / or add it to the readme

@rajat2004
Copy link
Contributor Author

rajat2004 commented Apr 15, 2020 •
edited
Loading

Need to add docstring for all the APIs to make it appear on the list, which is quite painful 😅
Also fixing the types of the params will be good to make it jump to the type definition

Well, just add undoc-members and voila!

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

@rajat2004 rajat2004 force-pushed the api-docs branch 4 times, most recently from 2ad3215 to f4f3d53 Compare April 18, 2020 15:17
@rajat2004 rajat2004 mentioned this pull request Apr 19, 2020
Merged
@rajat2004
Copy link
Contributor Author

rajat2004 commented Apr 19, 2020 •
edited
Loading

I've made a new PR #2599 while has some fixes noticed while working on this PR
Wanted to keep this one just for docs and not include other fixes which make things difficult while reviewing

Only some MoveBy APIs remaining. Note that I haven't personally tested all the APIs

@rajat2004 rajat2004 mentioned this pull request Apr 19, 2020
Closed
@rajat2004 rajat2004 force-pushed the api-docs branch 4 times, most recently from 9a92293 to 621fed9 Compare April 23, 2020 06:57
@madratman madratman merged commit ece5061 into microsoft:master Apr 29, 2020
@rajat2004 rajat2004 deleted the api-docs branch April 30, 2020 00:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rajat2004 @madratman