Skip to content

Commit a8dd71f

Browse files
docs: fix Sphinx formatting errors and single backticks
Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
1 parent 5d27eeb commit a8dd71f

3 files changed

Lines changed: 6 additions & 9 deletions

File tree

core/src/linkforge_core/composer/robot_builder.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
hierarchical construction of robot trees (links and joints) as well as
88
high-level assembly of pre-existing sub-components.
99
10-
Example:
10+
Examples:
1111
>>> builder = RobotBuilder("my_robot")
1212
>>> (
1313
... builder.link("base_link")
@@ -88,7 +88,6 @@ def link(self, name: str, parent: str | None = None) -> LinkBuilder:
8888
Args:
8989
name: Unique name for the link.
9090
parent: Optional parent link name to connect to immediately.
91-
9291
Returns:
9392
A LinkBuilder instance for fluent construction.
9493
"""

core/src/linkforge_core/models/robot.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ class Robot:
4747
Note:
4848
Uses O(1) hash map lookups for links and joints via internal indices.
4949
The kinematic structure (parent-child tree) is managed via the
50-
`graph` property.
50+
``graph`` property.
5151
"""
5252

5353
name: str
@@ -204,7 +204,7 @@ def prefix_all(self, prefix: str) -> None:
204204
name collisions.
205205
206206
Args:
207-
prefix: The string prefix to prepend (e.g., 'arm_').
207+
prefix: The string prefix to prepend (e.g., ``arm_``).
208208
"""
209209
if not prefix:
210210
return
@@ -648,15 +648,15 @@ def degrees_of_freedom(self) -> int:
648648
def links(self) -> tuple[Link, ...]:
649649
"""Get read-only view of links.
650650
651-
Use `add_link()` to modify the robot structure.
651+
Use ``add_link()`` to modify the robot structure.
652652
"""
653653
return tuple(self._links)
654654

655655
@property
656656
def joints(self) -> tuple[Joint, ...]:
657657
"""Get read-only view of joints.
658658
659-
Use `add_joint()` to modify the robot structure.
659+
Use ``add_joint()`` to modify the robot structure.
660660
"""
661661
return tuple(self._joints)
662662

core/src/linkforge_core/parsers/srdf_parser.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ def resolve_string(self, xml_string: str) -> str:
4646
4747
Args:
4848
xml_string: The raw string containing template directives.
49-
5049
Returns:
5150
A resolved XML string ready for parsing.
5251
"""
@@ -57,7 +56,7 @@ class SRDFParser(RobotXMLParser[SemanticRobotDescription]):
5756
"""Semantic Robot Description Format (SRDF) Parser.
5857
5958
This parser converts SRDF XML content into a structured
60-
`SemanticRobotDescription` model. It supports MoveIt-specific tags
59+
``SemanticRobotDescription`` model. It supports MoveIt-specific tags
6160
such as planning groups, end effectors, and collision disabling.
6261
"""
6362

@@ -91,7 +90,6 @@ def _parse_planning_group(self, group_elem: ET.Element) -> PlanningGroup:
9190
9291
Args:
9392
group_elem: The XML element for the group.
94-
9593
Returns:
9694
A populated PlanningGroup instance.
9795
"""

0 commit comments

Comments
 (0)