Skip to content

Update documentation#1269

Open
ViniciusTxc3 wants to merge 19 commits intopetrobras:mainfrom
ViniciusTxc3:update_documentation
Open

Update documentation#1269
ViniciusTxc3 wants to merge 19 commits intopetrobras:mainfrom
ViniciusTxc3:update_documentation

Conversation

@ViniciusTxc3
Copy link
Collaborator

@ViniciusTxc3 ViniciusTxc3 commented Feb 25, 2026

This PR addresses numerous documentation gaps and errors identified across the ROSS codebase. The primary focus was on adding missing docstrings, correcting parameter descriptions, and ensuring consistent documentation standards for analysis results and elements.

Checkpoints per File:

  • ross/bearing_seal_element.py
  • ross/coupling_element.py
  • ross/disk_element.py
  • ross/gear_element.py
  • ross/harmonic_balance.py
  • ross/materials.py
  • ross/model_reduction.py
  • ross/multi_rotor.py
  • ross/point_mass.py
  • ross/probe.py
  • ross/results.py
  • ross/rotor_assembly.py
  • ross/shaft_element.py
  • ross/utils.py
  • docs/user_guide/tutoriais*.ipynb

@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.03%. Comparing base (76d1013) to head (48a94a1).
⚠️ Report is 1 commits behind head on main.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1269   +/-   ##
=======================================
  Coverage   78.03%   78.03%           
=======================================
  Files          46       46           
  Lines       13283    13283           
=======================================
  Hits        10366    10366           
  Misses       2917     2917           
Files with missing lines Coverage Δ
ross/bearing_seal_element.py 89.08% <ø> (ø)
ross/coupling_element.py 85.12% <ø> (ø)
ross/disk_element.py 100.00% <ø> (ø)
ross/element.py 89.70% <ø> (ø)
ross/gear_element.py 79.20% <ø> (ø)
ross/harmonic_balance.py 72.64% <ø> (ø)
ross/model_reduction.py 80.86% <ø> (ø)
ross/point_mass.py 85.71% <ø> (ø)
ross/probe.py 76.47% <ø> (ø)
ross/results.py 76.77% <ø> (ø)
... and 3 more

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 56f624d...48a94a1. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

3 participants