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

sample versioning directives, empty + description#24160

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 1 commit intomatplotlib:mainfromstory645:versioning-directives
Oct 25, 2022

Conversation

story645
Copy link
Member

@story645story645 commentedOct 14, 2022
edited
Loading

Based on discussion on call and in#23506, trying out some versioning directives. Policy at#24161

Haven't styled anything yet, tried w/o and w/ description cause wasn't sure what made more sense. I guess w/o is a pointer to go look up those release notes, but not sure how to document that. The issue is that these two are partially new things - polar errobars and more valid parameter values, rather than wholly new things.

image
image
image

@story645story645 changed the titleadd versioning directives, including empty + descriptionsample versioning directives, empty + descriptionOct 14, 2022
@jklymak
Copy link
Member

I guess we should have discussed the threshold for this. I naively thought just for new methods or classes. What do other libraries do?

@story645
Copy link
MemberAuthor

Yeah I realized it was weird cause we use what's new for lots of what's changed and have almost no non-deprecation API changes

@timhoffm
Copy link
Member

and have almost no non-deprecation API changes

Which is a good thing (API stability 👍). Additions/extensions are in "What's new". Almost all other changes should have deprecations.

@story645
Copy link
MemberAuthor

Is there preference for the summary or blank version? If yes, should I document that in#24161? Also any styling preferences?

@timhoffm
Copy link
Member

Is there preference for the summary or blank version? If yes, should I document that in#24161?

Whether a comment makes semse depends is case-by-case: If the whole thing (function/parameter/...) is new there is nothing more to say. If only part is new, like in the {}-style example, that should be documented. If you want to be very explicit, you can document that, but I would also be ok to not write that out in text but add one more example with such a summary.

story645 reacted with thumbs up emoji

Co-authored-by: melissawm <melissawm@gmail.com>Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
@timhoffmtimhoffm added this to thev3.7.0 milestoneOct 25, 2022
@timhoffmtimhoffm merged commit7f0c965 intomatplotlib:mainOct 25, 2022
@story645story645 deleted the versioning-directives branchOctober 25, 2022 15:25
@story645story645 linked an issueOct 27, 2022 that may beclosed by this pull request
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
Projects
None yet
Milestone
v3.7.0
Development

Successfully merging this pull request may close these issues.

[Doc]: add sphinx versioning directives
3 participants
@story645@jklymak@timhoffm

[8]ページ先頭

©2009-2025 Movatter.jp