Skip to content

Commit 0edbcff

Browse files
authored
doc/resource_index: Indent list subitems correctly (#342)
The list subitems were indented only by one space, making them rendered (on GitHub) at the same level as their parent items. This made the list of requirements confusing. We indent them by one more space to render them properly as sub-items. Signed-off-by: Michal Sojka <[email protected]>
1 parent 3f992ad commit 0edbcff

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

ament_cmake_core/doc/resource_index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,21 @@ This project does not aim to catalog and explicitly reference all individual res
1313
These are the design requirements:
1414

1515
- Prevent recursive crawling
16-
- Resources should be cataloged in away in which no recursive crawling of directories is required
16+
- Resources should be cataloged in away in which no recursive crawling of directories is required
1717
- Autonomous Participation
18-
- Packages which register resources should be able to do so without invoking some other package (like this one)
18+
- Packages which register resources should be able to do so without invoking some other package (like this one)
1919
- Avoid installed file collisions
20-
- Participation should not require a package to overwrite or modify an existing file when installing
21-
- This is useful when packaging for Linux package managers
20+
- Participation should not require a package to overwrite or modify an existing file when installing
21+
- This is useful when packaging for Linux package managers
2222
- Do not try to capture all information
23-
- Many types of resources already provide mechanism for describing and referencing themselves, do not reinvent this
24-
- For example, if a system has plugins then it likely already has a mechanism for describing the plugins, this project should not try to capture all of that kind of meta information about individual resources
25-
- Stick to meta information about what resources are provided not meta information about the installed resources
23+
- Many types of resources already provide mechanism for describing and referencing themselves, do not reinvent this
24+
- For example, if a system has plugins then it likely already has a mechanism for describing the plugins, this project should not try to capture all of that kind of meta information about individual resources
25+
- Stick to meta information about what resources are provided not meta information about the installed resources
2626
- Support overlaying
27-
- If a package is installed into multiple prefixes on the system and those prefixes are ordered, return information based on that ordering
27+
- If a package is installed into multiple prefixes on the system and those prefixes are ordered, return information based on that ordering
2828
- Do not depend on externally defined environment variables or file formats
29-
- The `ROS_PACKAGE_PATH` and `CMAKE_PREFIX_PATH` environment variables
30-
- Parsing `package.xml`'s or `plugin.xml`'s
29+
- The `ROS_PACKAGE_PATH` and `CMAKE_PREFIX_PATH` environment variables
30+
- Parsing `package.xml`'s or `plugin.xml`'s
3131

3232
These requirements come from experience with the resource discovery system in [ROS](https://wiki.ros.org/), where packages were located anywhere recursively under one of several paths in the `ROS_PACKAGE_PATH` environment variable.
3333
This decision has lead to things like `rospack` caching information, which can get out of date, and then lead to subtle bugs for the users.

0 commit comments

Comments
 (0)