Skip to content
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

Improve/update docs on "Limitations, Design, and Other Projects" #36

Merged
merged 1 commit into from
May 12, 2024
Merged

Improve/update docs on "Limitations, Design, and Other Projects" #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
18 changes: 9 additions & 9 deletions doc/source/design_and_limits.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~
Expand All @@ -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
<https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Developer-Guide.html#testing>`__).
*Integration tests*, and *System tests* as per
`ROS2 terminology <https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Developer-Guide.html#testing>`__).
- 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 <https://docs.ros.org/en/rolling/Releases.html>`__ 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 <https://design.ros2.org/articles/roslaunch.html>`__.
- 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.
Expand Down
Loading