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

Make method documentation parameter descriptions have deterministic ordering #386

Closed
tcoffee-google opened this issue Apr 12, 2017 · 0 comments · Fixed by #1135
Closed

Make method documentation parameter descriptions have deterministic ordering #386

tcoffee-google opened this issue Apr 12, 2017 · 0 comments · Fixed by #1135
Assignees
@parthea
Labels
type: cleanup An internal cleanup or hygiene concern. type: docs Improvement to the documentation for an API.

Comments

@tcoffee-google
Copy link
Contributor

Currently, optional method parameters and nested object fields therein appear in nondeterministic order in Pydoc pages, presumably due to dict iteration. Regenerating documentation thereby leads to unnecessary changes in the listings of these parameters and fields, which can both confuse users and create misleading diff noise. Iterating over these parameters and fields in a deterministic order would resolve these problems. In particular, using an alphabetic ordering would improve users' ability to locate desired parameters in documentation.
@tcoffee-google tcoffee-google mentioned this issue Apr 12, 2017
Merged
@JustinBeckwith JustinBeckwith added triage me I really want to be triaged. 🚨 This issue needs some love. labels Jun 8, 2018
@JustinBeckwith JustinBeckwith added type: cleanup An internal cleanup or hygiene concern. and removed 🚨 This issue needs some love. triage me I really want to be triaged. labels Jun 20, 2018
@parthea parthea self-assigned this Dec 9, 2020
@parthea parthea added the type: docs Improvement to the documentation for an API. label Dec 10, 2020
@parthea parthea mentioned this issue Dec 13, 2020
Merged
4 tasks
gcf-merge-on-green bot pushed a commit that referenced this issue Dec 14, 2020
@parthea
docs: Reduce noisy changes in docs regen (#1135)
b1b0c83 
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code!  That way we can discuss the change, evaluate designs, and agree on the general idea
- [x] Ensure the tests and linter pass
- [x] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)

Fixes #386 🦕
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@parthea parthea

Labels
type: cleanup An internal cleanup or hygiene concern. type: docs Improvement to the documentation for an API.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Reduce noisy changes in docs regen parthea/google-api-python-client
3 participants
@JustinBeckwith @parthea @tcoffee-google