[RFC][Proof PR] use "deprecated" and "versionchanged" directives #11154
Conversation
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
OskarStark
changed the title
OskarStark
changed the title
|
I would not introduce |
wouterj
added
Waiting feedback
Status: Needs Work
and removed
Status: Needs Review
labels
2 tasks
javiereguiluz
added a commit
that referenced
this pull request
Mar 20, 2019
…karStark) This PR was squashed before being merged into the 3.4 branch (closes #11178). Discussion ---------- Use the ".. deprecated::" directive for deprecations Refs #11154 ## Todo: - [ ] We need no ensure the correct html markup - [ ] @symfony/docs-team please review the new documentation about "[how/when to use this new directive](2b0504d)" Commits ------- b48d0c7 Use the \".. deprecated::\" directive for deprecations
|
Closing because this has already been implemented in another PR. Thanks! |
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.
I have a small proposal regarding the
versionaddeddirectives. We are using this directive fornew stuff,deprecated stuffand we are using it for example fornew/changed stuff regarding other librariers(for example Swiftmailer, Webpack, Twig etc.)If I read this correct, RST supports the following directives out of the box:
.. versionadded::(for sure),.. versionchanged::and.. deprecated:::https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html?highlight=versionadded
My proposal: use
versionaddedonly for new Symfony stuff, useversionchangedas versionadded, but only for external libs/projects and do not useversionaddedfor deprecations anymore, lets use thedeprecateddirective.This PR shows, that the build is 💚 , the only thing left is to check the final markup, if it fits the Symfony website style.
.. deprecated::-> Use the ".. deprecated::" directive for deprecations #11178.. versionchanged::What do you think?