Skip to content

docs: add guidance on the less documented object types - #314

Merged
rich-iannone merged 2 commits into
mainfrom
docs-less-documented-object-types
Aug 10, 2026
Merged

docs: add guidance on the less documented object types#314
rich-iannone merged 2 commits into
mainfrom
docs-less-documented-object-types

Conversation

@rich-iannone

Copy link
Copy Markdown
Member

This PR enhances the docs for docstrings on non-class/function objects in Python. It adds a new GDG site for docstring coverage and expands the user guide with some recommendations and examples for documenting constants, module-level variables, type aliases, TypeVars, properties, and modules themselves.

@github-actions

Copy link
Copy Markdown

📚 Preview this PR's docs locally

Fetch the just-built site and open it in your browser:

# this exact build
great-docs preview --run 31407918652

# or always the latest build for this PR
great-docs preview --pr 314
Auth & tips
  • Requires great-docs: pip install great-docs (or run via pipx/uvx).
  • Auth: run gh auth login then add --use-gh, or set GITHUB_TOKEN (needs Actions: read).
  • Jump to a page: add --path reference/index.html.
  • Latest vs exact: --pr <n> grabs the newest build; --run <id> pins this one.
  • Re-download: --refresh ignores the local cache.

@rich-iannone
rich-iannone merged commit 9556c9b into main Aug 10, 2026
8 checks passed
@rich-iannone
rich-iannone deleted the docs-less-documented-object-types branch August 10, 2026 16:45
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.

1 participant