8000 Fix argument names in validate_file_md5, get_commit_info and init_mod_name docstrings by mmporong · Pull Request #4566 · nf-core/tools · GitHub
[go: up one dir, main page]

Skip to content

Fix argument names in validate_file_md5, get_commit_info and init_mod_name docstrings - #4566

Open
mmporong wants to merge 1 commit into
nf-core:devfrom
mmporong:fix-docstring-arg-names
Open

mmporong wants to merge 1 commit into
nf-core:devfrom
mmporong:fix-docstring-arg-names

Conversation

@mmporong
Copy link
Copy Markdown

PR checklist

  • This comment contains a description of changes (with reason)
  • CHANGELOG.md is updated
  • If you've fixed a bug or added code that should be tested, add tests!
  • Documentation in docs is updated

Three docstrings document an argument under a name the function does not take:

  • utils.validate_file_md5(file_name, expected_md5hex) documents expected.
  • SyncedRepo.get_commit_info(sha) documents commit_sha.
  • ComponentInfo.init_mod_name(component) documents module.

This renames them to expected_md5hex, sha and component; the descriptions are unchanged. I found them with an automated comparison of the Args: sections in nf_core/ against the function signatures. Docstring-only, so no tests. The CHANGELOG entry can be a 8000 dded with @nf-core-bot changelog once the PR has a number.

@mmporong
Copy link
Copy Markdown
Author

@nf-core-bot changelog

This branch has not been deployed

No deployments
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.

1 participant

0