Skip to content

Fix list output documentation #107

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

Open
jfbastien wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix list output documentation #107

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
201e92f
Fix list output documentation
jfbastien Aug 26, 2025
53b239a
typo
jfbastien Aug 26, 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
Next Next commit
Fix list output documentation 
The implementation at https://github.com/colcon/colcon-package-information/blob/master/colcon_package_information/verb/list.py
does: `pkg.name + '\t' + str(pkg.path) + '\t(%s)' % pkg.type`

The documentation wasn't precise about this.
  • Loading branch information
@jfbastien
jfbastien authored Aug 26, 2025
commit 201e92f88b93a9d7d0297b018dec0531c19b2058
4 changes: 2 additions & 2 deletions reference/verb/list.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
The ``list`` verb enumerates a set of packages.
It is provided by the ``colcon-package-information`` package.

For each package a line is shown containing the path, name and type separated
by tabs.
For each package a line is shown containing the the name, path and type (in
parentheses) separated by tabs.
By default the list is ordered alphabetically by the package name.
Optionally, it can order the packages topologically based on their dependencies.

Expand Down