Fix incorrect parameter names in docstrings#1685
Open
eeshsaxena wants to merge 1 commit into
Open
Conversation
Several :param: entries referenced names that don't match the function signatures: - Node.wait_for_node: node_name -> fully_qualified_node_name - get_action_client_names_and_types_by_node: node_namespace -> remote_node_namespace - get_action_server_names_and_types_by_node: node_namespace -> remote_node_namespace - ActionServer.register_handle_accepted_callback: goal_callback -> handle_accepted_callback Signed-off-by: eeshsaxena <[email protected]>
Contributor
|
Tick the box to add this pull request to the merge queue (same as
|
fujitatomoya
approved these changes
Jul 4, 2026
Collaborator
|
@eeshsaxena thanks for fixing. |
Collaborator
|
Pulls: #1685
|
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
2 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
:param:entries documented names that don't match the actual function signatures. This corrects them so the API docs render the right parameter names.Node.wait_for_node:node_name->fully_qualified_node_nameget_action_client_names_and_types_by_node:node_namespace->remote_node_namespaceget_action_server_names_and_types_by_node:node_namespace->remote_node_namespaceActionServer.register_handle_accepted_callback:goal_callback->handle_accepted_callbackDocumentation-only change; no behavior change.