Skip to content

DOC: add API docs content guidelines to api docs instructions #30085

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 20, 2025

Conversation

story645
Copy link
Member

@story645 story645 commented May 20, 2025

PR summary

PR checklist

@timhoffm
Copy link
Member

  • Renames write docstrings to API documentation per discussion in Doc: doc docs reorg #28578, which is roughly that folks need to know docstrings b/c they're writing API docs (& may not know they're called docstrings)

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.

Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

May self-merge after removing "new or edited"

story645 and others added 2 commits May 20, 2025 17:50
@story645
Copy link
Member Author

@timhoffm you didn't approve so I can't merge 😭

I would be hesitant to claim somebody knows "API" if they don't know "docstring".

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 timhoffm merged commit 1c84927 into matplotlib:main May 20, 2025
22 checks passed
@story645 story645 deleted the api-guidance branch May 20, 2025 22:48
@QuLogic QuLogic added this to the v3.11.0 milestone May 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: devdocs files in doc/devel
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants