Ruff DOC501 implementation

[je-cook]

Linked Issues

Closes #3484

Requires #3486

Description

Interface Changes

Checklist

I confirm that I have completed the following checks:

• Tests run locally and pass pytest tests --reactor
• Code quality checks run locally and pass pre-commit run --from-ref develop --to-ref HEAD
• Documentation built locally and checked sphinx-build -W documentation/source documentation/build

[codecov]

Codecov Report

Attention: Patch coverage is 70.73171% with 12 lines in your changes missing coverage. Please review.

Project coverage is 74.38%. Comparing base (b273a65) to head (f377a88).
Report is 45 commits behind head on develop.

Files with missing lines	Patch %	Lines
bluemira/codes/_freecadapi.py	0.00%	2 Missing ⚠️
...timisation/harmonics/harmonics_approx_functions.py	0.00%	2 Missing ⚠️
bluemira/fuel_cycle/cycle.py	0.00%	2 Missing ⚠️
bluemira/fuel_cycle/tools.py	83.33%	2 Missing ⚠️
bluemira/fuel_cycle/analysis.py	0.00%	1 Missing ⚠️
bluemira/magnetostatics/fem_utils.py	50.00%	1 Missing ⚠️
...luemira/radiation_transport/flux_surfaces_maker.py	50.00%	1 Missing ⚠️
bluemira/utilities/tools.py	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3487      +/-   ##
===========================================
- Coverage    74.39%   74.38%   -0.02%     
===========================================
  Files          230      230              
  Lines        26628    26632       +4     
===========================================
- Hits         19811    19810       -1     
- Misses        6817     6822       +5     

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

[oliverfunk]

very nice

[sonarcloud]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[github-actions]

⚠️ Warning Report

Found 1 new warning, 1 fixed warning.

New warnings (6)

On runtest

• /home/runner/work/bluemira/bluemira/bluemira/equilibria/optimisation/harmonics/harmonics_approx_functions.py:41: RuntimeWarning: divide by zero encountered in log10

All warnings (6)

On runtest

• /home/runner/miniconda3/envs/bluemira/lib/python3.10/site-packages/ffcx/element_interface.py:26: DeprecationWarning: Converting elements created in UFL to Basix elements is deprecated. You should create the elements directly using basix.ufl.element instead
• /home/runner/work/bluemira/bluemira/bluemira/equilibria/optimisation/harmonics/harmonics_approx_functions.py:41: RuntimeWarning: divide by zero encountered in log10
• /home/runner/miniconda3/envs/bluemira/lib/python3.10/site-packages/ffcx/element_interface.py:23: DeprecationWarning: Use of elements created by UFL is deprecated. You should create elements directly using Basix.
• /home/runner/miniconda3/envs/bluemira/lib/python3.10/site-packages/basix/ufl.py:1909: DeprecationWarning: Converting elements created in UFL to Basix elements is deprecated. You should create the elements directly using basix.ufl.element instead
• /home/runner/miniconda3/envs/bluemira/lib/python3.10/site-packages/ufl/core/expr.py:275: DeprecationWarning: Expr.ufl_domain() is deprecated, please use extract_unique_domain(expr) instead.

On collect

• /home/runner/miniconda3/envs/bluemira/lib/python3.10/site-packages/ufl/core/ufl_type.py:56: DeprecationWarning: attach_operators_from_hash_data deprecated, please use UFLObject instead.