From e226c2bd14228a5a517e2846793cec72ca92162f Mon Sep 17 00:00:00 2001 From: Felix Divo Date: Sun, 12 May 2024 00:31:24 +0000 Subject: [PATCH] Improve/update docs on "Limitations, Design, and Other Projects" --- README.md | 1 + doc/source/design_and_limits.rst | 18 +++++++++--------- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 982bd7c..66897e0 100644 --- a/README.md +++ b/README.md @@ -111,6 +111,7 @@ Some hints: ## Limitations, Design, and Other Projects See [the documentation on that](https://ros2-easy-test.readthedocs.io/en/latest/design_and_limits.html). +Please read it before suggesting major features or changes. ## Contributing diff --git a/doc/source/design_and_limits.rst b/doc/source/design_and_limits.rst index aa4a8f5..9a26c9f 100644 --- a/doc/source/design_and_limits.rst +++ b/doc/source/design_and_limits.rst @@ -34,7 +34,7 @@ Current Limitations Design Considerations --------------------- -These were the initial design considerations. Over time, this may shift. +These were (mostly) the initial design considerations. Over time, this may shift. Goals ~~~~~ @@ -44,20 +44,20 @@ Goals - Allow for concise tests. Little to no infrastructure code should be required for typical scenarios. - Automate common checks where possible (e.g. nodes should not crash). - Support testing single and multiple nodes in combination (i.e. support *Unit tests* (of single nodes), - *Integration tests* and *System tests* as per - `ROS2 terminology - `__). + *Integration tests*, and *System tests* as per + `ROS2 terminology `__). - Be well-documented and easy to get started. -- Support the most widely used platforms (that have not reached end of life yet). Be pragmatic. +- Support the most widely used platforms (that have not `reached end-of-life `__ yet). + Be pragmatic. Constraints ~~~~~~~~~~~ - Be easy to maintain by needing only a few lines of code (below a thousand). - Thus, actions are currently not supported. - Also, we only use public APIs wherever possible. -- Don't reinvent the wheel and benefit from future improvements: Use existing functionality of Python and - ROS2. This includes: :mod:`unittest`, :mod:`pytest`, and the + We only use public APIs wherever possible. +- Don't reinvent the wheel and benefit from future improvements: + Use existing functionality of Python and ROS2. + This includes: :mod:`unittest`, :mod:`pytest`, and the `ROS2 launch system `__. - Efficiency is not a primary concern as this mini-framework is intended to only be used for testing and not in a real robot deployment, where performance is much more of a concern.