search

For-a-few-DPPs-more / structure-factor

Compute structure factor of stationary and isotropic point processes
https://for-a-few-dpps-more.github.io/structure-factor/
MIT License
10 stars 5 forks source link

Write good and formated docstrings #2

Closed guilgautier closed 2 years ago

guilgautier commented 3 years ago

It is important to write more explicit docstrings, and decide which docstring format to use and stick to it. you can have a look at this compact post https://stackoverflow.com/a/24385103

Note: you can partially automate docstring generation in your text editor, in VS-Code for example there's https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring

guilgautier commented 2 years ago

Everything seems pretty much ok now!