This repository was archived by the owner on Mar 7, 2019. It is now read-only.
Improve help + flags, update README #44
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
Contributor
|
This is awesome. It's really cool to see the project getting better and |
README.md
Outdated
|
|
||
| ## Integrating With Your Application | ||
|
|
||
| To profile profiling endpoints in your application, follow the official |
Contributor
There was a problem hiding this comment.
Somewhat awkward wording: "To profile profiling..."
Contributor
Author
There was a problem hiding this comment.
Good catch, meant "To add profiling", updated.
Contributor
|
Looks good to me! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Flags now pass through unknown flags (like
--alloc_objects) togo tool pprof, and are broken into multiple sections.Restructure the README into:
Can see the rendered output here:
https://github.com/uber/go-torch/blob/readme/README.md
Focus examples on more common usage, and remove less frequently used examples like outputting an SVG to stdout or outputting the raw flamegraph input.