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

hyphen no longer supported #899

Merged
merged 1 commit into from
Aug 14, 2024
Merged

hyphen no longer supported #899

merged 1 commit into from
Aug 14, 2024

Conversation

jdkent
Copy link
Member

@jdkent jdkent commented Aug 14, 2024

Closes # .

Changes proposed in this pull request:

  • setuptools is deprecating hyphens in names.

Summary by Sourcery

Update setup.cfg to replace hyphen with underscore in the 'description_file' field to align with setuptools deprecation of hyphens in names.

Enhancements:

  • Replace hyphen with underscore in the 'description_file' field in setup.cfg to comply with setuptools naming conventions.

@jdkent jdkent merged commit 4beb01c into main Aug 14, 2024
1 check was pending
Copy link
Contributor

sourcery-ai bot commented Aug 15, 2024

Reviewer's Guide by Sourcery

This pull request addresses a deprecation warning from setuptools regarding the use of hyphens in configuration keys. The change involves updating the 'description-file' key in the setup.cfg file to use an underscore instead of a hyphen, becoming 'description_file'.

File-Level Changes

Files Changes
setup.cfg Replaced the hyphenated key 'description-file' with the underscore-separated 'description_file' in the package configuration

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @jdkent - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider updating the PR title and description to be more specific. For example, the title could be 'Update setup.cfg to replace hyphen with underscore for setuptools compatibility' and the description could mention the specific change made and why it's necessary.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

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