Skip to content

Make method documentation parameter descriptions have deterministic ordering #386

@tcoffee-google

Description

@tcoffee-google

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.

Metadata

Metadata

Assignees

Labels

type: cleanupAn internal cleanup or hygiene concern.type: docsImprovement to the documentation for an API.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions