search

giotto-ai / giotto-deep

Deep learning made topological.
Other
79 stars 11 forks source link

Have consistent code formatting. #67

Closed raphaelreinauer closed 2 years ago

raphaelreinauer commented 2 years ago

Description: Different parts of the code will use different conventions for variable and function names, comments, and general organization. This leads to inconsistency which can make code difficult to read.

Resolution: Follow a style guide so that all code has a consistent appearance. Agree on a style guide with all developers in our team and define it in a config file.

Tools: Use Black (https://github.com/psf/black) for code formatting. It can be set up to run automatically on commit.

matteocao commented 2 years ago

also performed the refactoring with jblack https://github.com/irahorecka/jupyterblack We shall add the use of black as code formatter in the issue template, but I would not force the refactoring on the merge.