ULB-Metronu / georges

Opinionated particle accelerator modeling Python package.

https://ulb-metronu.github.io/georges/

GNU General Public License v3.0

7 stars 8 forks source link

Improve apertures definition #79

Closed rtesse closed 9 months ago

rtesse commented 9 months ago

Description

Better explanation in the documentation the parameters for the apertures.

Fixes #77

Type of change

Please select options that are relevant.

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] This change requires a documentation update

How Has This Been Tested?

N.A

Checklist:

[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my code
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[x] I have added tests that prove my fix is effective or that my feature works
[x] New and existing unit tests pass locally with my changes

sonarcloud[bot] commented 9 months ago

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud