Skip to content

Commit a7b8d4d

Browse files
committed
Update "Catalog of best practices" section in the README
1 parent 1587414 commit a7b8d4d

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -88,14 +88,15 @@ For further information on the available options, please refer to the project [d
8888

8989
## Catalog of best practices
9090

91-
Pynblint currently implements 22 linting rules based on empirically-validated best practices for collaborative Jupyter notebook usage:
92-
- 17 rules applicable to standalone notebooks
93-
- 5 rules applicable to entire data science repositories
91+
Pynblint currently implements 22 linting rules:
9492

95-
These rules are derived from our comprehensive catalog of best practices collaborative notebook development [\[1\]](#references). Below is the current implementation state of linting rules associated with each best practice:
93+
- 17 rules applicable to standalone notebooks;
94+
- 5 rules applicable to entire data science repositories.
95+
96+
These rules are derived from our comprehensive catalog of best practices for collaborative notebook development [\[1\]](#references). Below is the current implementation state of linting rules associated with each best practice:
9697

9798
- :white_check_mark: Complete: Fully implemented
98-
- :puzzle_piece: Partial: Partially implemented with planned improvements
99+
- :jigsaw: Partial: Partially implemented with planned improvements
99100
- :hourglass_flowing_sand: In Progress: Implementation planned for future releases
100101
- :x: Not Planned: No implementation planned
101102

@@ -106,10 +107,10 @@ These rules are derived from our comprehensive catalog of best practices collabo
106107
| 3. *Use self-contained environments* | :hourglass_flowing_sand: In Progress: | *Planned*: detection of<br>- Python virtual environments (e.g., created with `venv`, `pyenv`, or `conda`)<br>- containerized environments (e.g., Docker). |
107108
| 4. *Put imports at the beginning* | :white_check_mark: Complete | Fully implemented |
108109
| 5. *Ensure re-executability (re-run notebooks top to bottom)* | :white_check_mark: Complete | Fully implemented |
109-
| 6. *Modularize your code* | :puzzle_piece: Partial | *Current*: detection of modularization constructs in notebooks.<br>*Planned*: modularization-focused refactoring recommendations based on detected patterns |
110-
| 7. *Test your code* | :puzzle_piece: Partial | *Current*: repository-level detection of coverage data.<br>*Planned*: detection of test modules/functions independent of coverage tools |
110+
| 6. *Modularize your code* | :jigsaw: Partial | *Current*: detection of modularization constructs in notebooks.<br>*Planned*: modularization-focused refactoring recommendations based on detected patterns |
111+
| 7. *Test your code* | :jigsaw: Partial | *Current*: repository-level detection of coverage data.<br>*Planned*: detection of test modules/functions independent of coverage tools |
111112
| 8. *Name your notebooks consistently* | :white_check_mark: Complete | Fully implemented |
112-
| 9. *Stick to coding standards* | :puzzle_piece: Partial | *Current*: detection of cells with invalid Python syntax.<br>*Planned*: Integration of Python linters such as pylint, flake8, and ruff |
113+
| 9. *Stick to coding standards* | :jigsaw: Partial | *Current*: detection of cells with invalid Python syntax.<br>*Planned*: Integration of Python linters such as pylint, flake8, and ruff |
113114
| 10. *Use relative paths* | :hourglass_flowing_sand: In Progress: | *Planned*: identification of absolute paths instances in notebooks and recommendation of corresponding relative paths |
114115
| 11. *Document your analysis* | :white_check_mark: Complete | Fully implemented |
115116
| 12. *Leverage Markdown headings to structure your notebook* | :white_check_mark: Complete | Fully implemented |

0 commit comments

Comments
 (0)