docs(direct_url): render ArchiveInfo, DirInfo, VcsInfo fields via autoclass#1225
Open
r266-tech wants to merge 3 commits into
Open
docs(direct_url): render ArchiveInfo, DirInfo, VcsInfo fields via autoclass#1225r266-tech wants to merge 3 commits into
r266-tech wants to merge 3 commits into
Conversation
Contributor
Author
|
Pushed a fix for the red docs build. The bare |
The bare `autoclass` directives emitted the dataclasses' auto-generated signature as the docstring (`ArchiveInfo(*, ...)`), which docutils parsed as an unterminated inline-emphasis marker and failed the -W docs build. Give each class a one-line docstring and exclude __init__/__new__ to match the DirectUrl directive, so the field tables render without warnings.
henryiii
force-pushed
the
docs-direct-url-autoclass
branch
from
8975975 to
087638e
Compare
Contributor
|
Needs reformatting. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Reference section renders
ArchiveInfo,DirInfo, andVcsInfoas bare.. class::stubs (just the class name), even though all three are public (__all__) frozen dataclasses whose keyword-only fields the Usage example above already constructs (hashes,editable,vcs/commit_id/requested_revision).Switching them to
.. autoclass:: :members: :undoc-members:(the same patternRawMetadatauses inmetadata.rst) renders those field signatures, matching the existingDirectUrlentry just above them.Pure docs, no code change.