Skip to content

Commit

Permalink
Merge branch 'documentation-for-python-can-transport-interface' of ht…
Browse files Browse the repository at this point in the history
…tps://github.com/mdabrowski1990/uds into documentation-for-python-can-transport-interface
  • Loading branch information
mdabrowski1990 committed Oct 31, 2023
2 parents dcd443f + 386599a commit 91ca794
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions docs/source/pages/user_guide/segmentation.rst
Expand Up @@ -24,7 +24,7 @@ Following functionalities are provided by :class:`~uds.segmentation.can_segmente

As a user, you are able to configure :class:`~uds.segmentation.can_segmenter.CanSegmenter` parameters which determines
the addressing (Addressing Format and Addressing Information of input and output CAN packets) and the content
(e.g. Filler Byte value and whether to use CAN Frame Data Optimization) of CAN Packets.
(e.g. Filler Byte value and whether to use CAN Frame Data Optimization) of CAN packets.

**Example code:**

Expand Down Expand Up @@ -137,8 +137,8 @@ Following functionalities are provided by :class:`~uds.segmentation.can_segmente
uds_message_1 = can_segmenter.desegmentation(can_packets_1)
uds_message_2 = can_segmenter.desegmentation(can_packets_2)
.. warning:: Desegmentation performs only sanity check of CAN Packets content, therefore some inconsistencies
.. warning:: Desegmentation performs only sanity check of CAN packets content, therefore some inconsistencies
with Diagnostic on CAN standard might be silently accepted as long as a message can be unambiguously decoded
out of provided CAN packets.

.. note:: Desegmentation can be perform for any CAN Packets (not only those targeting this CAN Node) in any format.
.. note:: Desegmentation can be performed for any CAN packets (not only those targeting this CAN Node) in any format.
2 changes: 1 addition & 1 deletion pyproject.toml
Expand Up @@ -49,7 +49,7 @@ dynamic = ["version"]

[project.urls]
"Homepage" = "https://github.com/mdabrowski1990/uds"
"User Documentation" = "https://uds.readthedocs.io/en/latest/"
"User Documentation" = "https://uds.readthedocs.io"
"Repository" = "https://github.com/mdabrowski1990/uds"
"Issues Tracking System" = "https://github.com/mdabrowski1990/uds/issues"
"Releases and Changelogs" = "https://github.com/mdabrowski1990/uds/releases"
Expand Down

0 comments on commit 91ca794

Please sign in to comment.