Commit ed2bea0
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 module1 parent c8c5eea commit ed2bea0
File tree
19 files changed
+26631
-2831
lines changed- assets/IAH
- flopyparser
- tests
- mf executables/mac
- reference_model_runs
19 files changed
+26631
-2831
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
84 | 84 | | |
85 | 85 | | |
86 | 86 | | |
| 87 | + | |
| 88 | + | |
0 commit comments