Skip to content

DCR-CORE - Development - Code Formatting

GitHub (Pre-)Release GitHub (Pre-)Release Date

The tools Black, docformatter and isort are used for formatting the programme code:

  • Black - The uncompromising Python code formatter.
  • docformatter - Formats docstrings to follow PEP 257.
  • isort - A Python utility / library to sort imports.

All these tools are included in the call make format as well as in the call make dev. They can be executed individually with make black, make pydocstyle or make isort, where the recommended order is first make isort, then make black and finally make pydocstyle.