search

modflowpy / flopy

A Python package to create, run, and post-process MODFLOW-based models.
https://flopy.readthedocs.io
Other
506 stars 306 forks source link

docs: clean-up commented-out code and other comments #2218

Closed martclanor closed 2 months ago

martclanor commented 2 months ago

This PR aims to clean-up docs/comments in python files. Primarily, it removes commented-out lines of code that appear to have been unintentionally staged for commit.

The deletions include:

The deletions do not include: .docs/Notebooks/*.py

I tried to make the deletions as I see fit, then I staged each one-by-one for a double-check, but of course, it won't be perfect. The autotest/ files are a little bit more challenging because of commented-out code that is used for debugging/visual debugging, or marked as an in-progress TODO. Whenever I hesitated, I opted to leave the line unchanged.

But as the changes are limited to comments, for the most part, they should not affect the existing behavior of the code, hence the "docs" label for this PR.

While it can be argued that some deleted comments could serve as future references, since we are working with git, of course, no code is ever truly lost, so I thought it should be okay to clean this up.

In hindsight, creating an issue first to discuss this would have been a good idea. 😅

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 72.2%. Comparing base (d81d7c0) to head (18955e7). Report is 4 commits behind head on develop.

:exclamation: Current head 18955e7 differs from pull request most recent head 66f9510

Please upload reports for the commit 66f9510 to get more accurate results.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #2218 +/- ## ========================================= + Coverage 69.8% 72.2% +2.3% ========================================= Files 294 294 Lines 59008 59008 ========================================= + Hits 41228 42643 +1415 + Misses 17780 16365 -1415 ``` | [Files](https://app.codecov.io/gh/modflowpy/flopy/pull/2218?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy) | Coverage Δ | | |---|---|---| | [flopy/discretization/grid.py](https://app.codecov.io/gh/modflowpy/flopy/pull/2218?src=pr&el=tree&filepath=flopy%2Fdiscretization%2Fgrid.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy#diff-ZmxvcHkvZGlzY3JldGl6YXRpb24vZ3JpZC5weQ==) | `75.7% <ø> (+0.6%)` | :arrow_up: | | [flopy/discretization/vertexgrid.py](https://app.codecov.io/gh/modflowpy/flopy/pull/2218?src=pr&el=tree&filepath=flopy%2Fdiscretization%2Fvertexgrid.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy#diff-ZmxvcHkvZGlzY3JldGl6YXRpb24vdmVydGV4Z3JpZC5weQ==) | `81.7% <ø> (ø)` | | | [flopy/export/metadata.py](https://app.codecov.io/gh/modflowpy/flopy/pull/2218?src=pr&el=tree&filepath=flopy%2Fexport%2Fmetadata.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy#diff-ZmxvcHkvZXhwb3J0L21ldGFkYXRhLnB5) | `23.3% <ø> (ø)` | | | [flopy/export/netcdf.py](https://app.codecov.io/gh/modflowpy/flopy/pull/2218?src=pr&el=tree&filepath=flopy%2Fexport%2Fnetcdf.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy#diff-ZmxvcHkvZXhwb3J0L25ldGNkZi5weQ==) | `49.2% <ø> (ø)` | | | [flopy/export/shapefile\_utils.py](https://app.codecov.io/gh/modflowpy/flopy/pull/2218?src=pr&el=tree&filepath=flopy%2Fexport%2Fshapefile_utils.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy#diff-ZmxvcHkvZXhwb3J0L3NoYXBlZmlsZV91dGlscy5weQ==) | `70.7% <100.0%> (ø)` | | | [flopy/export/utils.py](https://app.codecov.io/gh/modflowpy/flopy/pull/2218?src=pr&el=tree&filepath=flopy%2Fexport%2Futils.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy#diff-ZmxvcHkvZXhwb3J0L3V0aWxzLnB5) | `41.5% <ø> (ø)` | | | [flopy/export/vtk.py](https://app.codecov.io/gh/modflowpy/flopy/pull/2218?src=pr&el=tree&filepath=flopy%2Fexport%2Fvtk.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy#diff-ZmxvcHkvZXhwb3J0L3Z0ay5weQ==) | `78.2% <ø> (+0.1%)` | :arrow_up: | | [flopy/mbase.py](https://app.codecov.io/gh/modflowpy/flopy/pull/2218?src=pr&el=tree&filepath=flopy%2Fmbase.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy#diff-ZmxvcHkvbWJhc2UucHk=) | `70.4% <ø> (+0.5%)` | :arrow_up: | | [flopy/mf6/coordinates/simulationtime.py](https://app.codecov.io/gh/modflowpy/flopy/pull/2218?src=pr&el=tree&filepath=flopy%2Fmf6%2Fcoordinates%2Fsimulationtime.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy#diff-ZmxvcHkvbWY2L2Nvb3JkaW5hdGVzL3NpbXVsYXRpb250aW1lLnB5) | `54.0% <ø> (ø)` | | | [flopy/mf6/data/mfdatastorage.py](https://app.codecov.io/gh/modflowpy/flopy/pull/2218?src=pr&el=tree&filepath=flopy%2Fmf6%2Fdata%2Fmfdatastorage.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy#diff-ZmxvcHkvbWY2L2RhdGEvbWZkYXRhc3RvcmFnZS5weQ==) | `71.3% <ø> (+3.6%)` | :arrow_up: | | ... and [49 more](https://app.codecov.io/gh/modflowpy/flopy/pull/2218?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy) | | ... and [76 files with indirect coverage changes](https://app.codecov.io/gh/modflowpy/flopy/pull/2218/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy)