Docstring examples

[yaniccd]

Added examples and references to the docstrings. Slight modification to the docstring format.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

Files with missing lines	Coverage Δ
haarpy/circular_ensembles.py	100.00% <ø> (ø)
haarpy/orthogonal.py	100.00% <100.00%> (ø)
haarpy/partition.py	100.00% <ø> (ø)
haarpy/permutation.py	100.00% <100.00%> (ø)
haarpy/symmetric.py	100.00% <ø> (ø)
haarpy/symplectic.py	100.00% <100.00%> (ø)
haarpy/tests/test_circular_ensembles.py	100.00% <100.00%> (ø)
haarpy/tests/test_permutation.py	100.00% <100.00%> (ø)
haarpy/unitary.py	100.00% <ø> (ø)

🚀 New features to boost your workflow:

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

[nquesada]

Would it be possible to add a reference?

[yaniccd]

I have put the reference on top of every .py files, right below the module description. I saw it done that way in a sympy file I believe. This notation comes from [1] for instance. I personally like to put the reference on top to avoid repeating the same ref in every function. The downside is that it is not explicit what reference correspond to which function. Most reference are related to every function of the module. Thoughts?

[nquesada]

I think is motly ok. However, one issue with this that often you want to see the docstring while typing code. I guess more often than not, what you want are examples, not references so maybe it is OK.

[nquesada]

I kind of like the wikipedia references to all the group theory concepts ¯_(ツ)_/¯

[yaniccd]

I like it as well. I am not sure how to format it though to avoid the clash between proper reference and Wikipedia reference. Thoughts?

[nquesada]

Found some typos and a potential incomplete example.
Also, personally, I prefer to write do not and does not as opposed to don't and doesn't, but I won't try to impose that here.