Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(InputOutput.f90): cleanup docstrings in IO utility #1552

Merged
merged 16 commits into from
Jan 18, 2024

Conversation

emorway-usgs
Copy link
Contributor

  • Started with docstrings cleanup and expanded from there.
    • There was some imported mf2k/mf2k5 style code that was massaged into the new code format (lowercase vars, etc.).
    • There remains a number of go to statements that would be nice to remove in the future.
  • Ran fprettify

@emorway-usgs emorway-usgs marked this pull request as draft January 17, 2024 01:41
@emorway-usgs emorway-usgs marked this pull request as ready for review January 18, 2024 12:56
Copy link
Contributor

@langevin-usgs langevin-usgs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found one small typo, but otherwise looks good. Nice job.

src/Utilities/InputOutput.f90 Outdated Show resolved Hide resolved
@mjreno
Copy link
Contributor

mjreno commented Jan 18, 2024

@emorway-usgs This file has been excluded from the fprettify formatting check as the tool previously changed it in unexpected ways- if these changes address that you can remove it from the exclude list in .github/common/fortran_format_check.py

@emorway-usgs
Copy link
Contributor Author

@emorway-usgs This file has been excluded from the fprettify formatting check as the tool previously changed it in unexpected ways- if these changes address that you can remove it from the exclude list in .github/common/fortran_format_check.py

Thanks @mjreno, InputOutput.f90 should now be good to go with fprettify. The line you suggested now contains an empty list. As best I could tell, running fprettify was itself shifting the format statements represented with strings such that they were right justified to column 83, which is wider than the 80 characters per line limit.

@langevin-usgs langevin-usgs merged commit be38bb4 into MODFLOW-USGS:develop Jan 18, 2024
15 checks passed
@emorway-usgs emorway-usgs deleted the cleanup_io_docstrings branch January 18, 2024 20:53
@emorway-usgs emorway-usgs added the maintenance Sprucing up the code label Feb 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Sprucing up the code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants