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

fixed typo in setup manholes parameters #187

Merged
merged 8 commits into from
Oct 18, 2024

Conversation

veenstrajelmer
Copy link
Collaborator

@veenstrajelmer veenstrajelmer commented Oct 16, 2024

Issue addressed

Fixes #126

Explanation

The docstring is not aligned with the actual argument name for the function. Instead of updating the docstring, I renamed the argument name to be consistent with related argument/file names, so from manhole_defaults_fn to manholes_defaults_fn. I have added this to the changelog. We might want to include a deprecation error, but that would be more cumbersome and the docs provide information about available keywords anyway.

Checklist

  • Updated tests or added new tests
  • Branch is up to date with main
  • Tests & pre-commit hooks pass
  • Updated documentation if needed
  • Updated changelog.rst if needed

@veenstrajelmer veenstrajelmer linked an issue Oct 16, 2024 that may be closed by this pull request
1 task
Copy link

sonarcloud bot commented Oct 18, 2024

@veenstrajelmer veenstrajelmer removed the request for review from hboisgon October 18, 2024 04:10
@veenstrajelmer veenstrajelmer merged commit dca452d into main Oct 18, 2024
9 checks passed
@veenstrajelmer veenstrajelmer deleted the 126-typo-in-setup_manholes-parameters branch October 18, 2024 04:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Typo in setup_manholes parameters
2 participants