Skip to content

Commit ed2bea0

Browse files
committed
docs: standardize documentation with numpy-style docstrings
- Add comprehensive module-level docstrings to all flopyparser modules - Convert all function/method docstrings to numpy documentation style - Standardize parameter documentation with proper Parameters/Returns sections - Enhance class docstrings with detailed descriptions and attributes - Apply consistent formatting throughout codebase with ruff - Improve code readability and maintainability Changes include: - flopyparser/__init__.py: Add package description - flopyparser/flopyparser.py: Update CLI interface documentation - flopyparser/model.py: Enhance Model class and method documentation - flopyparser/parameter.py: Document Parameter class and utility functions - flopyparser/metafunctions.py: Add processing function documentation - flopyparser/version.py: Add version module description - flopyparser/__main__.py: Document entry point module
1 parent c8c5eea commit ed2bea0

File tree

19 files changed

+26631
-2831
lines changed

19 files changed

+26631
-2831
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,3 +84,5 @@ log.txt
8484
assets/IAH/Poster A22.pdf
8585
assets/IAH/~poster a2~pj2l-j.idlk
8686
assets/IAH/~workflow~2$wxpt.idlk
87+
.vscode/settings.json
88+
tests/mf executables

0 commit comments

Comments
 (0)