Skip to content

Commit

Permalink
Fix documentation to pass doc8-test
Browse files Browse the repository at this point in the history
Signed-off-by: Denisa <[email protected]>
  • Loading branch information
depink5 committed Oct 7, 2024
1 parent 1a9535c commit 4d71184
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/04-common/python_requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ SWIG

SWIG_ is a development tool that allows connecting programs written in C/C++ with a variety of
other programming languages, among them Python.
SWIG 4.0 is required in order to build Fast DDS Python bindings.
SWIG 4.1 is required in order to build Fast DDS Python bindings.

.. note::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ Getting started
eProsima DDS Record & Replay includes the following tools:

- **DDS Recorder tool**: This tool's primary function is to store data in an MCAP database,
including the publication timestamp, serialized data, and its format. The output MCAP file can be read by any compatible tool,
including the publication timestamp, serialized data, and its format.
The output MCAP file can be read by any compatible tool,
as it contains all necessary information for data reproduction.

- **DDS Remote Controller tool**: This application enables remote control of the recording tool,
Expand Down Expand Up @@ -59,7 +60,8 @@ Recorder configuration
^^^^^^^^^^^^^^^^^^^^^^

``ddsrecorder`` runs with default configuration settings.
This default configuration records all messages of all DDS Topics found in DDS Domain ``0`` in the ``output_YYYY-MM-DD-DD_hh-mm-ss.mcap`` file.
This default configuration records all messages of all DDS Topics found in
DDS Domain ``0`` in the ``output_YYYY-MM-DD-DD_hh-mm-ss.mcap`` file.

Additionally, it is possible to change the default configuration parameters by means of a YAML configuration file.

Expand Down Expand Up @@ -95,5 +97,6 @@ Next Steps
The usage of the DDS Remote Controller and DDS Replay tools follows
the same steps as the DDS Recorder tool.

For further information, please refer to the
`eProsima DDS Record and Replay documentation <https://dds-recorder.readthedocs.io/en/latest/index.html>`_.
For further information, please refer to the
`eProsima DDS Record and Replay documentation
<https://dds-recorder.readthedocs.io/en/latest/index.html>`_.

0 comments on commit 4d71184

Please sign in to comment.