conda/conda-package-handling

Miscellaneous code style issues

travishathaway opened this issue · 2 comments

travishathaway commented

What is the idea?

For conda projects, it is preferred to use spelled out rather than abbreviated variable names. We need to clean up this project to make sure that we are following this rule.

Another this project has is inconsistent string interpolation methods. The entire project should be using f-string format.

Why is this needed?

Implementing these fixes will help boost the overall code quality and readability.

What should happen?

  • Replace kw with kwargs
  • Replace fn with filename
  • Replace pkg with package
  • Make sure all string interpolation is using f-strings
  • Remove any unused imports
dholth commented

However, callers could pass the positional arguments as keyword arguments somefunction(fn="the filename") so this would be an API change.

github-actions commented

Hi there, thank you for your contribution!

This issue has been automatically marked as stale because it has not had recent activity. It will be closed automatically if no further activity occurs.

If you would like this issue to remain open please:

  1. Verify that you can still reproduce the issue at hand
  2. Comment that the issue is still reproducible and include:
    - What OS and version you reproduced the issue on
    - What steps you followed to reproduce the issue

NOTE: If this issue was closed prematurely, please leave a comment.

Thanks!