DOC: add API docs content guidelines to api docs instructions#30085
Merged
timhoffm merged 2 commits intomatplotlib:mainfrom May 20, 2025
Merged
DOC: add API docs content guidelines to api docs instructions#30085timhoffm merged 2 commits intomatplotlib:mainfrom
timhoffm merged 2 commits intomatplotlib:mainfrom
Conversation
Member
Remark: I would be hesitant to claim somebody knows "API" if they don't know "docstring". Either may be the case, but generally, I'd expect that most people wo can meaningfully update this know both. My primary reason for suggesting renaming is that API documentation is more general and we can put "inheritance diagrams" under that topic as well. |
timhoffm
reviewed
May 20, 2025
Member
timhoffm
left a comment
There was a problem hiding this comment.
May self-merge after removing "new or edited"
Co-authored-by: Tim Hoffmann <[email protected]>
Member
Author
|
@timhoffm you didn't approve so I can't merge 😭
Sorry for the mischaracterization, I was thinking more of how we were discussing orienting around purpose (why they need to know this tech) rather than the specific tech. |
timhoffm
approved these changes
May 20, 2025
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
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.
PR summary
PR checklist