docs: add units to seconds based timesteps

[apaletta3]

Summary by CodeRabbit

• Documentation
  • Improved documentation for the time_step parameter in numerical solver functions, clarifying that values must be specified in seconds.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

---

📝 Walkthrough

Walkthrough

Updated documentation strings in Python bindings and C++ headers for the NumericalSolver class to specify that time_step parameters represent values in seconds. No functional code changes, behavior modifications, or signature alterations were made.

Changes

Cohort / File(s)	Summary
NumericalSolver Documentation bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/NumericalSolver.cpp, include/OpenSpaceToolkit/Astrodynamics/Trajectory/State/NumericalSolver.hpp	Clarified documentation strings for time_step/aTimeStep parameters in constructors and factory methods (FixedStepSize, Conditional) by adding "(in seconds)" specification. No code signature or behavior changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

• vishwa2710

Poem

🐰 A hop, a skip, some docs so bright,
Time steps now measured just right,
In seconds clear, no more confusion,
Our solver shines with bright illusion!
Words refined, precision blessed,
Documentation at its best! ✨

🚥 Pre-merge checks | ✅ 3 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately and concisely describes the main change: adding unit specifications (seconds) to documentation for time step parameters.
Merge Conflict Detection	✅ Passed	✅ No merge conflicts detected when merging into main

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/add-units-to-timesteps

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.95%. Comparing base (ee00684) to head (f055ebf).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #649   +/-   ##
=======================================
  Coverage   91.95%   91.95%           
=======================================
  Files         114      114           
  Lines       11120    11120           
=======================================
  Hits        10225    10225           
  Misses        895      895           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.