Skip to content

Updated coding style documention - #462

Merged
kanekosh merged 2 commits into
mainfrom
docs-update
Oct 8, 2025
Merged

Updated coding style documention#462
kanekosh merged 2 commits into
mainfrom
docs-update

Conversation

@kanekosh

@kanekosh kanekosh commented Oct 6, 2025

Copy link
Copy Markdown
Collaborator

Purpose

Updated the coding style documentation page as we switched to Ruff. We now simply link to the Mach-Aero documentation page on code styling, as we use the same setup.

I also added isort documentation.

Expected time until merged

1 day

Type of change

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (non-backwards-compatible fix or feature)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Documentation update
  • Maintenance update
  • Other (please describe)

Testing

Checklist

  • I have run ruff check and ruff format to make sure the Python code adheres to PEP-8 and is consistently formatted
  • I have formatted the Fortran code with fprettify or C/C++ code with clang-format as applicable
  • I have run unit and regression tests which pass locally with my changes
  • I have added new tests that prove my fix is effective or that my feature works
  • I have added necessary documentation

@codecov

codecov Bot commented Oct 6, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.26%. Comparing base (88b7104) to head (e47bedf).
⚠️ Report is 8 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #462   +/-   ##
=======================================
  Coverage   86.26%   86.26%           
=======================================
  Files          24       24           
  Lines        3429     3429           
=======================================
  Hits         2958     2958           
  Misses        471      471           

☔ 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.

@kanekosh
kanekosh marked this pull request as ready for review October 7, 2025 17:49
@kanekosh
kanekosh requested a review from a team as a code owner October 7, 2025 17:49
@kanekosh
kanekosh requested review from ArshSaja and sabakhshi October 7, 2025 17:49
@kanekosh
kanekosh merged commit 8554985 into main Oct 8, 2025
16 checks passed
@kanekosh
kanekosh deleted the docs-update branch October 8, 2025 14:20
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.

2 participants