Repository navigation
Update docs - #1044
Merged
Merged
Update docs#1044
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1044 +/- ##
==========================================
- Coverage 92.31% 92.27% -0.04%
==========================================
Files 103 103
Lines 13363 13363
Branches 483 483
==========================================
- Hits 12336 12331 -5
- Misses 1027 1032 +5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
godlygeek
requested changes
Oct 14, 2026
Update supported Python and macOS versions, CLI help, defaults, attach methods and report descriptions, and document the speedscope transform format. Signed-off-by: Kirill Ignatev <kignatev@bloomberg.net>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Several docs statements no longer match the code: supported Python and macOS versions,
treedefaults and root totals,attachmethods, live and CSV report descriptions, README CLI help, output file names, live mode threads.I changed to recommend installing with
python3instead ofpython3.9so we don't need to keep updating it as new versions come out.No issue. No news entry.
Describe your changes
Corrected the outdated statements and documented the
speedscopetransform format andsys.remote_execattach method.No functional changes, just docs.
Testing performed
Verified that the code performs according to the updated description.