Repository navigation
docs: AGENTS.md asks for a docstring on each public attribute and property - #12
Merged
Merged
Conversation
…perty The API reference gives each one its own page, which is where See Also and Examples go, as in pandas. A property with no docstring shows an empty row.
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
1 participant
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.
Since #9, the API reference gives every public attribute and property its own page, as pandas does. Those pages are where See Also and Examples go, but most are one sentence for now (in PYSTILT, 42 of 67 property pages), and a property with no docstring shows an empty table row.
This adds a line to the generated
AGENTS.md, under the docstring conventions, asking contributors and agents to say what each public attribute and property is, and to add See Also or Examples where they help. It reaches each package withcopier update.just testpasses for both variants.