search

valdanchev / reproducible-data-science-python

Reproducible Data Science with Python
Other
20 stars 9 forks source link

JOSE Review: Code quality #8

Closed lechten closed 2 years ago

lechten commented 2 years ago

This is related to your JOSE submission.

One of the learning objectives is: “Write clean, reusable, and reproducible code in Python.” For “clean code”, I strongly suggest to add pointers for style guides and tools. Then, please run pylint or flake8 on your notebooks, e.g., with nbQA, and decide what rules to follow. In what regard is “reusable” addressed?

valdanchev commented 2 years ago

Added a section entitled Readability of your Python code in which PEP 8 style guide for Python code is introduced and key relevant recommendations for writing a readable Python code are outlined, including (i) naming conventions, (ii) maximum line length, (iii) indentation, (iv) tabs or spaces?, (v) whitespace in expressions and statements.

The resource now conforms to the Python’s official PEP 8 style guide for Python code—the automated code formatter Black and style guide checker flake8 were executed via nbQA on all Jupyter notebooks. The notebook performing the formatting is included in the repository folder tools.

A new section on code reusability named Code reuse: creating your own functions was added.

lechten commented 2 years ago

Cool!