Skip to content

Add C++ rotation docs and update Python docs#82

Merged
chemiskyy merged 1 commit intomasterfrom
add/documentation
Mar 24, 2026
Merged

Add C++ rotation docs and update Python docs#82
chemiskyy merged 1 commit intomasterfrom
add/documentation

Conversation

@chemiskyy
Copy link
Copy Markdown
Member

Add a new simcoon_docs header providing C++/Python docstrings for Rotation (simcoon-python-builder/include/simcoon/docs/Libraries/Maths/doc_rotation.hpp), and update the pybind wrapper to use those doc constants (rotation.cpp). Update Sphinx docs to clarify expected input shapes with a table and add a batch-rotation example for Gauss-point quantities (docs/continuum_mechanics/functions/doc_rotation.rst, docs/cpp_api/simulation/rotation.rst). This centralizes documentation strings and improves docs for batch operations and Voigt rotation helpers.

Add a new simcoon_docs header providing C++/Python docstrings for Rotation (simcoon-python-builder/include/simcoon/docs/Libraries/Maths/doc_rotation.hpp), and update the pybind wrapper to use those doc constants (rotation.cpp). Update Sphinx docs to clarify expected input shapes with a table and add a batch-rotation example for Gauss-point quantities (docs/continuum_mechanics/functions/doc_rotation.rst, docs/cpp_api/simulation/rotation.rst). This centralizes documentation strings and improves docs for batch operations and Voigt rotation helpers.
Copy link
Copy Markdown
Collaborator

@pruliere pruliere left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great feature !

@chemiskyy chemiskyy merged commit b996db0 into master Mar 24, 2026
7 checks passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in simcoon 2.0 Mar 24, 2026
@chemiskyy chemiskyy deleted the add/documentation branch March 24, 2026 16:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants