Update LoggerInterface hyperlink to GitHub page #16102
Merged
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
BahmanMD
suggested changes
Nov 15, 2021
| @@ -41,7 +41,7 @@ To log a message, inject the default logger in your controller or service:: | |||
| } | |||
|
|
|||
| The ``logger`` service has different methods for different logging levels/priorities. | |||
| See `LoggerInterface`_ for a list of all of the methods on the logger. | |||
| See .. _`LoggerInterface`: https://github.com/php-fig/log/blob/master/src/LoggerInterface.php for a list of all of the methods on the logger. | |||
There was a problem hiding this comment.
It is better to change this line as follow:
See `LoggerInterface <https://github.com/php-fig/log/blob/master/src/LoggerInterface.php>`_ for a list of all of the methods on the logger.
On this line 'The logger service has different methods for different logging levels/priorities. See LoggerInterface for a list of all of the methods on the logger.' the LoggerInterface link leads to a 404 GitHub page. This PR is to update it to the correct link.
javiereguiluz
force-pushed
the
patch-2
branch
from
b3da8d2 to
3b32e41
Compare
|
Abdellah, thanks for fixing this issue and congrats on your first Symfony Docs contribution 🎉 As discussed on Symfony Slack, the RST syntax used in docs is a bit tricky at first. That's why we made some tweaks to this pull request. The needed fix was to update the link at the bottom of the page. There's no need to add the URL inside the text. See 09e26d1 (please note that my tweaks contain some changes not strictly related to your fix). |
|
Hi @javiereguiluz thank you for the note and guidance. I will do that next time. |
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.
On this line 'The logger service has different methods for different logging levels/priorities. See LoggerInterface for a list of all of the methods on the logger.' the LoggerInterface link leads to a 404 GitHub page. This PR is to update it to the correct link.