Skip to content

Emit documentation blocks in generated models.pyi files - #856

Open
kuhe wants to merge 2 commits into
developfrom
kuhe/docs
Open

kuhe wants to merge 2 commits into
developfrom
kuhe/docs

Conversation

@kuhe

@kuhe kuhe commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Documentation comments for models.pyi.

No __doc__ for runtime though. That would require carrying a lot more text in memory.

@kuhe
kuhe marked this pull request as ready for review October 19, 2026 19:43
@kuhe
kuhe requested a review from a team as a code owner October 19, 2026 19:43
writeMemberDocs(writer, member);
}
if (carriesResponseMetadata(shape)) {
writer.write("response_metadata: $T = ...", RuntimeTypes.RESPONSE_METADATA);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we restore the response_metadata docs here too? This field had generated docs before lazy loading, and writeMemberDocs can’t cover it since it isn’t modeled

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same thing with ServiceError

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the response_metadata block is too repetitive, since it appears on all classes. The ResponseMetadata type will provide that information.

ServiceError can have a docblock, in commit 2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants