Skip to content

Fixes docstrings inconsistencies the code #2112

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.

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

Merged
merged 5 commits into from
Mar 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ Guidelines for modifications:
* Jia Lin Yuan
* Jinghuan Shang
* Jingzhou Liu
* Jinqi Wei
* Johnson Sun
* Kaixi Bao
* Kourosh Darvish
Expand Down
2 changes: 1 addition & 1 deletion source/isaaclab/isaaclab/envs/mdp/actions/actions_cfg.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ class JointEffortActionCfg(JointActionCfg):
class JointPositionToLimitsActionCfg(ActionTermCfg):
"""Configuration for the bounded joint position action term.

See :class:`JointPositionWithinLimitsAction` for more details.
See :class:`JointPositionToLimitsAction` for more details.
"""

class_type: type[ActionTerm] = joint_actions_to_limits.JointPositionToLimitsAction
Expand Down
2 changes: 1 addition & 1 deletion source/isaaclab/isaaclab/sim/schemas/schemas_cfg.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class ArticulationRootPropertiesCfg:
"""Solver position iteration counts for the body."""

solver_velocity_iteration_count: int | None = None
"""Solver position iteration counts for the body."""
"""Solver velocity iteration counts for the body."""

sleep_threshold: float | None = None
"""Mass-normalized kinetic energy threshold below which an actor may go to sleep."""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ class TerrainGeneratorCfg:
"""

use_cache: bool = False
"""Whether to load the sub-terrain from cache if it exists. Defaults to True.
"""Whether to load the sub-terrain from cache if it exists. Defaults to False.

If enabled, the generated terrains are stored in the cache directory. When generating terrains, the cache
is checked to see if the terrain already exists. If it does, the terrain is loaded from the cache. Otherwise,
Expand Down