doc: #81 comply with ruff pydocstyle (D)

[cmp0xff]

Close #81 .

[github-actions[bot]]

Coverage Report (cf49177dc1a76d353767ed919b260230f4517db6, 3.10, ubuntu-latest)

File	Stmts	Miss	Cover	Missing
hamilflow
__init__.py	0	0	100%
hamilflow/maths
__init__.py	2	0	100%
trigonometrics.py	13	2	2	85%
hamilflow/models
__init__.py	0	0	100%
brownian_motion.py	48	1	1	98%
free_particle.py	35	0	100%
harmonic_oscillator.py	109	8	8	93%
harmonic_oscillator_chain.py	45	7	7	84%
pendulum.py	59	2	2	97%
hamilflow/models/kepler_problem
__init__.py	2	0	100%
dynamics.py	61	2	2	97%
model.py	125	10	10	92%
numerics.py	55	7	7	87%
hamilflow/models/utils
__init__.py	0	0	100%
typing.py	3	0	100%
TOTAL	557	39	93%

Tests	Skipped	Failures	Errors	Time
2642	22 :zzz:	0 :x:	0 :fire:	19.196s :stopwatch:

[github-actions[bot]]

Coverage Report (7bd71d7cfccd3c4af2e656afeb2952eea969c2f7, 3.11, macos-latest)

File	Stmts	Miss	Cover	Missing
hamilflow
__init__.py	0	0	100%
hamilflow/maths
__init__.py	2	0	100%
trigonometrics.py	13	2	2	85%
hamilflow/models
__init__.py	0	0	100%
brownian_motion.py	48	1	1	98%
free_particle.py	35	2	2	94%
harmonic_oscillator.py	109	8	8	93%
harmonic_oscillator_chain.py	45	7	7	84%
pendulum.py	59	2	2	97%
hamilflow/models/kepler_problem
__init__.py	2	0	100%
dynamics.py	61	2	2	97%
model.py	125	10	10	92%
numerics.py	55	7	7	87%
hamilflow/models/utils
__init__.py	0	0	100%
typing.py	3	0	100%
TOTAL	557	41	93%

Tests	Skipped	Failures	Errors	Time
2640	22 :zzz:	0 :x:	0 :fire:	10.369s :stopwatch:

[github-actions[bot]]

PR Preview Action v1.4.7 :---: Preview removed because the pull request was closed. 2024-08-31 13:00 UTC