Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
DOC: Added call out to API guidelines to contribute + small API guidelines reorg#27650
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
Uh oh!
There was an error while loading.Please reload this page.
Conversation
doc/devel/api_changes.rst Outdated
.. _api_whats_new: | ||
Announce changes, deprecations, and new features | ||
------------------------------------------------ | ||
Announce new features, API changes, and deprecations |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Take or leave: Announcing is done after one has done the implementation. Therefore I'm slightly in favor of moving this section to the bottom so that the new order is:
- Add new API and features
- Deprecate API
- Announce new features, API changes, and deprecations
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Agree, I think what I've done here is blend overview with the announcement specific relevant stuff, so I may separate that out.
added callout in coding guidelines to make more obvious.Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
@timhoffm updated it so that the announce section is a bit less overview and pushed it to the bottom. |
Uh oh!
There was an error while loading.Please reload this page.
PR summary
Spun docs changes out of#27641 to let that one go through faster. Changes here are:
API->changes
toAPI->guidelines
API Guidelines
so top level is announce, add new features, deprecatePR checklist