From 201e92f88b93a9d7d0297b018dec0531c19b2058 Mon Sep 17 00:00:00 2001 From: JF Bastien Date: Tue, 26 Aug 2025 14:52:04 +0900 Subject: [PATCH 1/2] 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. --- reference/verb/list.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/reference/verb/list.rst b/reference/verb/list.rst index f9f1db1..3b803ba 100644 --- a/reference/verb/list.rst +++ b/reference/verb/list.rst @@ -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. From 53b239a3cf84ce816e5d8b1da4f71aff6a3918ad Mon Sep 17 00:00:00 2001 From: JF Bastien Date: Tue, 26 Aug 2025 14:53:08 +0900 Subject: [PATCH 2/2] typo --- reference/verb/list.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/verb/list.rst b/reference/verb/list.rst index 3b803ba..65f40b7 100644 --- a/reference/verb/list.rst +++ b/reference/verb/list.rst @@ -4,7 +4,7 @@ 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 the name, path and type (in +For each package a line is shown containing 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.