Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
timhoffm merged 2 commits intomatplotlib:mainfromstory645:api-guidance
May 20, 2025

Conversation

story645
Copy link
Member

@story645story645 commentedMay 20, 2025
edited
Loading

PR summary

PR checklist

@timhoffm
Copy link
Member

  • Renames write docstrings to API documentation per discussion inDoc: 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.

story645 reacted with thumbs up emoji

Copy link
Member

@timhoffmtimhoffm 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"

story645and others added2 commitsMay 20, 2025 17:50
@story645
Copy link
MemberAuthor

@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.

@timhoffmtimhoffm merged commit1c84927 intomatplotlib:mainMay 20, 2025
22 checks passed
@story645story645 deleted the api-guidance branchMay 20, 2025 22:48
@QuLogicQuLogic added this to thev3.11.0 milestoneMay 20, 2025
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@timhoffmtimhoffmtimhoffm approved these changes

Assignees
No one assigned
Labels
Documentation: devdocsfiles in doc/devel
Projects
None yet
Milestone
v3.11.0
Development

Successfully merging this pull request may close these issues.

3 participants
@story645@timhoffm@QuLogic

[8]ページ先頭

©2009-2025 Movatter.jp