Skip to content

GH-142646: Update Tachyon to use backtick formatting in CLI help #142647

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pablogsal merged 3 commits into from
Dec 13, 2025
+12 −16
Merged

GH-142646: Update Tachyon to use backtick formatting in CLI help #142647

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0e80de8
Use backticks and clean up styles
savannahostrowski Dec 12, 2025
1accb7b
Cleanup
savannahostrowski Dec 12, 2025
ebdc142
Merge branch 'main' into tachyon-color-cli
savannahostrowski Dec 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 12 additions & 16 deletions Lib/profiling/sampling/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,24 +41,20 @@ class CustomFormatter(

_HELP_DESCRIPTION = """Sample a process's stack frames and generate profiling data.
Commands:
Copy link
Member Author

@savannahostrowski savannahostrowski Dec 12, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found this pretty redundant given that we have the same info in positional args. I can revert if someone disagrees?

Before:

Image

After:

Image

run Run and profile a script or module
attach Attach to and profile a running process
Examples:
# Run and profile a script
python -m profiling.sampling run script.py arg1 arg2
`python -m profiling.sampling run script.py arg1 arg2`
# Attach to a running process
python -m profiling.sampling attach 1234
`python -m profiling.sampling attach 1234`
# Live interactive mode for a script
python -m profiling.sampling run --live script.py
`python -m profiling.sampling run --live script.py`
# Live interactive mode for a running process
python -m profiling.sampling attach --live 1234
`python -m profiling.sampling attach --live 1234`
Use 'python -m profiling.sampling <command> --help' for command-specific help."""
Use `python -m profiling.sampling <command> --help` for command-specific help."""


# Constants for socket synchronization
Expand Down Expand Up @@ -506,19 +502,19 @@ def main():
Examples:
# Run and profile a module
python -m profiling.sampling run -m mymodule arg1 arg2
`python -m profiling.sampling run -m mymodule arg1 arg2`
# Generate flamegraph from a script
python -m profiling.sampling run --flamegraph -o output.html script.py
`python -m profiling.sampling run --flamegraph -o output.html script.py`
# Profile with custom interval and duration
python -m profiling.sampling run -i 50 -d 30 script.py
`python -m profiling.sampling run -i 50 -d 30 script.py`
# Save collapsed stacks to file
python -m profiling.sampling run --collapsed -o stacks.txt script.py
`python -m profiling.sampling run --collapsed -o stacks.txt script.py`
# Live interactive mode for a script
python -m profiling.sampling run --live script.py""",
`python -m profiling.sampling run --live script.py`""",
)
run_parser.add_argument(
"-m",
Expand Down Expand Up @@ -554,10 +550,10 @@ def main():
Examples:
# Profile all threads, sort by total time
python -m profiling.sampling attach -a --sort tottime 1234
`python -m profiling.sampling attach -a --sort tottime 1234`
# Live interactive mode for a running process
python -m profiling.sampling attach --live 1234""",
`python -m profiling.sampling attach --live 1234`""",
)
attach_parser.add_argument(
"pid",
Expand Down
Loading