Skip to content

refactor: audit and core documentation standardization#246

Open
arounamounchili wants to merge 24 commits into
mainfrom
docs/refine-init-docstring
Open

refactor: audit and core documentation standardization#246
arounamounchili wants to merge 24 commits into
mainfrom
docs/refine-init-docstring

Conversation

@arounamounchili
Copy link
Copy Markdown
Owner

@arounamounchili arounamounchili commented May 14, 2026

Pull Request

Important

This project uses Conventional Commits and Release Please for automated versioning.
Please ensure your PR title follows the Conventional Commits format (e.g., feat: add lidar sensor, fix: core logic bug).

📝 Description

audit and core documentation standardization

🛠️ Type of change

  • 🧹 Refactor (refactor)
  • 📚 Documentation (docs)

✅ Checklist

  • I have run uv run pytest and all tests pass
  • I have run uv run pre-commit run --all-files and all hooks pass
  • I have verified the changes manually in the Blender viewport
  • I have updated the documentation or verified no changes are needed

Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
…ors, and models

Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
…idation checks

Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
…lity.py

Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
- Standardized all core modules with Lean Google Style documentation.
- Hardened SensorTranslator with explicit casting and 3D LIDAR support.
- Synchronized Blender SensorPropertyGroup with core LIDAR requirements.
- Formalized 'Physics as Truth' design principle in contributing guide.
- Added PHYSICS_AS_TRUTH.md developer documentation.
- Resolved LIDAR validation regression in blender integration tests.

Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
@arounamounchili arounamounchili changed the title Docs/refine init docstring refactor: audit and core documentation standardization May 14, 2026
…uristics

Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
- Centralized all magic literals in core and blender platforms.
- Reorganized constants for improved logical flow and maintainability.
- Resolved import instabilities in URDF/SRDF parsers.
- Rephrased legacy comments into professional compatibility notices.
- Fixed numerical precision regressions in joint tests.
- Verified with full test suite, linting, and type checking.

Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
…lized constants

Signed-off-by: arounamounchili <patouossa.mounchili@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant