FESTIM icon indicating copy to clipboard operation
FESTIM copied to clipboard

Documentation: code style

Open KulaginVladimir opened this issue 1 year ago • 3 comments

The FESTIM code is formatted with Black.

I think it'd be beneficial to explicitly specify this in the Contributing to the code section of developer's guide.

KulaginVladimir avatar Aug 01 '24 09:08 KulaginVladimir

It would also help to show a few commands on how to format a script with the black command

black my_script.py

or

black .

RemDelaporteMathurin avatar Aug 01 '24 15:08 RemDelaporteMathurin

I found it that the content of the index.rst under devguide is different with the content of the merged ones in Developer's guide in FESTIM documentation when I want to make the modification to specify the code style.

Here's the content of the index.rst under devguide:

1) `Fork the repository <https://github.com/festim-dev/FESTIM/fork>`_

By forking the repository, you create a copy where you can safely make changes.

2) Make your changes
3) `Open a PR <https://github.com/festim-dev/FESTIM/compare>`_
4) Wait for a :ref:`maintainer<Maintainers>` to review your PR

Before merging your changes, they have to be reviewed. We ensure the changes don't break anything during the review and eventually propose/request improvements.
The time before the review will depend on the maintainers' availability.

5) When everything is in order, the maintainers will merge your PR!

Here is the content of the merged in Developer's guide in FESTIM documentation: https://festim.readthedocs.io/en/latest/devguide/index.html.

XinShen-CHN avatar Aug 07 '24 08:08 XinShen-CHN

This is the difference between the latest and stable versions of the documentation.

stable is the latest released festim version (here 1.3.1) latest is the latest pushed version (on the main branch)

RemDelaporteMathurin avatar Aug 07 '24 12:08 RemDelaporteMathurin