Updated documentation for Live Mode and Flame Graph #376
Conversation
This file contains 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
drz416
changed the title
|
Seems that we need to run black over |
godlygeek
force-pushed
the
documentation
branch
4 times, most recently
from
7ca64be
to
6e97e42
Compare
1) Update "The run subcommand" page such that it's explicit about the random port being generated and its method of usage 2) Update "Live Reporting" page. Fixed two typos and moved one of the sections Signed-off-by: Dee Lucic <dlucic@gmail.com>
1) Updated Non-relevant Frame Hiding section to match the flamegraph wording of "Irrelevant" 2) Updated the Hide Irrelevant Frames button screenshot 3) Added a new section called Inverted View to describe two modes of viewing flame graphs 4) Added a screenshot for the Invert button 5) Added a threaded version of mandelbrot script 6) Updated the flame graph that displays split-threads view with the output of the new threaded mandelbrot script Signed-off-by: Dee Lucic <dlucic@gmail.com>
godlygeek
force-pushed
the
documentation
branch
from
6e97e42
to
ec97080
Compare
|
Thank you Matt @godlygeek, happy to be able to help! Glad to meet you guys earlier this week as well! |
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.
Issue number of the reported bug or feature request: #371 and #71
Describe your changes
Updated documentation for Live Mode in two locations:
1) "The run subcommand" page such that it's explicit about the random port being generated and its method of usage
2) "Live Reporting" page. Fixed two typos and moved one of the sections
Updated the "Flame Graph Reporter" doc page with the following:
1) Updated Non-relevant Frame Hiding section to match the flamegraph wording of "Irrelevant
2) Updated the Hide Irrelevant Frames button screenshot
3) Added a new section called Inverted View to describe two modes of viewing flame graphs
4) Added a screenshot for the Invert button
5) Added a threaded version of mandelbrot script
6) Updated the flame graph that displays split-threads view with the output of the new
threaded mandelbrot script
Testing performed
I reviewed the updates to the .rst files with a markdown viewer inside my VSCode (reStructuredText extension)
Additional context
No changes to source code