Improve developers' documentation - Githubissues

pyccel / psydac

Python 3 library for isogeometric analysis

https://pyccel.github.io/psydac/

MIT License

47 stars 17 forks source link

Improve developers' documentation #390

Open jowezarek opened 6 months ago

jowezarek commented 6 months ago

Help improving Psydac's docstrings - any contribution is welcome @pyccel/psydac-dev !

Files updated so far in this PR:

...
...
...

To locally view your changes

Follow the instructions in our developers' documentation.

To do

[ ] Explain how to add a new file the documentation
[ ] Explain what to do if an existing file has been renamed
[ ] Point to numpydoc documentation for guidelines on docstring formatting
[ ] Mention PEP-8 for conventions on general formatting
[ ] Add workflows for compliance to numpydoc guidelines and PEP-8 conventions (see Pyccel)