Skip to content
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

Adjust topic hz and bw command description. #987

Merged
merged 3 commits into from
Mar 14, 2025
Merged

Adjust topic hz and bw command description. #987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1cee775
Adjust topic hz and bw command description.
fujitatomoya Mar 13, 2025
b762d20
note description fix.
fujitatomoya Mar 13, 2025
8a73859
address flake8 warnings.
fujitatomoya Mar 14, 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
7 changes: 7 additions & 0 deletions ros2topic/ros2topic/verb/bw.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,13 @@ class BwVerb(VerbExtension):
"""Display bandwidth used by topic."""

def add_arguments(self, parser, cli_name):
parser.description = (
'Display bandwidth used by topic.\n\n'
'note:\n'
' This bandwidth reflects the receiving rate on subscription, '
'which might be affected by platform resources and QoS configuration, '
"and may not exactly match the publisher's bandwidth."
)
arg = parser.add_argument(
'topic',
help='Topic name to monitor for bandwidth utilization')
Expand Down
9 changes: 8 additions & 1 deletion ros2topic/ros2topic/verb/hz.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,16 @@


class HzVerb(VerbExtension):
"""Print the average publishing rate to screen."""
"""Print the average receiving rate to screen."""

def add_arguments(self, parser, cli_name):
parser.description = (
'Print the average receiving rate to screen.\n\n'
'note:\n'
' This rate reflects the receiving rate on subscription, '
'which might be affected by platform resources and QoS configuration, '
"and may not exactly match the publisher's rate."
)
arg = parser.add_argument(
'topic_name',
nargs='+',
Expand Down