ros2 / ros2/ros2cli

[ros2lifecycle] list --include-hidden-nodes argument is unnecessary because node_name is required

Open
#171 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
262
Forks
228
Avg merge
23h 15m
Merged PRs (30d)
12

Description

ros2 lifecycle list has an unnecessary option --include-hidden-nodes.
This is not needed because the node name is a required argument to the command.

The option is added here
https://github.com/ros2/ros2cli/blob/af65db2d95fbbd436308d7fd363c6545342496ad/ros2lifecycle/ros2lifecycle/verb/list.py#L36-L38

But removing it will require changing the NodeNameCompleter to allow always checking hidden nodes.

https://github.com/ros2/ros2cli/blob/af65db2d95fbbd436308d7fd363c6545342496ad/ros2node/ros2node/api/__init__.py#L75-L87

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in ros2lifecycle/ros2lifecycle/verb/list.py at the option definition linked in the issue, then inspect ros2node/ros2node/api/init.py where NodeNameCompleter is defined. Remove the unnecessary option and update completion so hidden nodes are always checked; verify the lifecycle list command and its node-name completion behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.