[Console] Added documentation about command profiling #19265
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
alamirault
reviewed
Dec 12, 2023
OskarStark
reviewed
Dec 14, 2023
|
cc @HeahDude as you contributed the feature |
alexandre-daubois
approved these changes
Dec 14, 2023
HeahDude
reviewed
Dec 14, 2023
console.rst
Outdated
| Profiling Commands | ||
| ------------------ | ||
|
|
||
| When debug mode is enabled, you can run a command with the ``--profile`` option. |
There was a problem hiding this comment.
Suggested change
| When debug mode is enabled, you can run a command with the ``--profile`` option. | |
| When debug mode and the profiler are enabled, you can run a command with the ``--profile`` option. |
console.rst
Outdated
| ------------------ | ||
|
|
||
| When debug mode is enabled, you can run a command with the ``--profile`` option. | ||
| Symfony will then collect data about the command's execution. When the execution |
There was a problem hiding this comment.
Suggested change
| Symfony will then collect data about the command's execution. When the execution | |
| Symfony will then collect data about the command execution. When the execution |
console.rst
Outdated
|
|
||
| When debug mode is enabled, you can run a command with the ``--profile`` option. | ||
| Symfony will then collect data about the command's execution. When the execution | ||
| is over, the profile is accessible through the :doc:`Symfony Profiler </profiler>`. |
There was a problem hiding this comment.
Suggested change
| is over, the profile is accessible through the :doc:`Symfony Profiler </profiler>`. | |
| is over, the profile is accessible through the web pages of the :doc:`Symfony Profiler </profiler>`. |
8d58f82 to
4945d0a
Compare
|
@maelanleborgne thanks and congrats on your first Symfony Docs contribution 🎉 While merging I did some minor reword (e.g. to move the terminal code example from inside the tip to the main content) but most of your contribution remained the same. Thanks also to the reviewers for a very nice work! |
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 just noticed the new
--profileoption wasn't documented (only on this blog post) yet, so here's a PR with just some minimal info added to the console page.