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.

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

Add types to topic_or_service_is_hidden.py #1231

Merged
merged 1 commit into from
Mar 8, 2024
Merged
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion rclpy/rclpy/topic_or_service_is_hidden.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
HIDDEN_TOPIC_PREFIX = '_'


def topic_or_service_is_hidden(name):
def topic_or_service_is_hidden(name: str) -> bool:
Copy link
Member

Choose a reason for hiding this comment

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

Should we remove the typing info from the param documentation below?

-:param name str: topic or service name to test
+:param name: topic or service name to test

Copy link
Collaborator

Choose a reason for hiding this comment

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

"""
Return True if a given topic or service name is hidden, otherwise False.

Expand Down