Skip to content

🔧 MAINTAIN: Update development packages #154

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

Merged
merged 3 commits into from
Apr 25, 2021
Merged

Conversation

chrisjsewell
Copy link
Member

The name of the package is already set up to use markdown-it-py in numerous places, but setup_cfg_fmt is hard-coded to convert these dashes to underscores https://github.com/asottile/setup-cfg-fmt/blob/de922db829605a067c7a407eb42620c3cb4466a0/setup_cfg_fmt.py#L365 🤷

@chrisjsewell chrisjsewell requested a review from hukkin April 1, 2021 04:01
@codecov
Copy link

codecov bot commented Apr 1, 2021

Codecov Report

Merging #154 (3b2b1ad) into master (13c5129) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #154   +/-   ##
=======================================
  Coverage   96.10%   96.10%           
=======================================
  Files          60       60           
  Lines        3232     3232           
=======================================
  Hits         3106     3106           
  Misses        126      126           
Flag Coverage Δ
pytests 96.10% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 13c5129...3b2b1ad. Read the comment docs.

@hukkin
Copy link
Contributor

hukkin commented Apr 1, 2021

The underscored name will be normalized as per https://www.python.org/dev/peps/pep-0503/#normalized-names so it shouldn't be an issue. setup-cfg-fmt itself can be used to demonstrate: it defines underscored name in setup.cfg but the name shows hyphened on PyPI page and the package is installable with pip install setup-cfg-fmt. The package also refers to itself using the hyphened name in the README etc.

Here's the reasoning why setup-cfg-fmt chooses to use underscores.

So personally I'd prefer keep the formatter (but won't be upset if you remove it 😄).

@chrisjsewell
Copy link
Member Author

There's other things like the Conda build though, and yeh I can't be bothered to deal with potential side effects for the sake of a formatter.
If you could just turn this one change off, then I'd certainly want to keep it

@hukkin
Copy link
Contributor

hukkin commented Apr 1, 2021

In fact we could change the name to markdown--_---......it-_py lol. You can try pip install markdown--_---......it-_py, works perfectly 😄

@chrisjsewell chrisjsewell changed the title 🔧 MAINTAIN: Fix name of package 🔧 MAINTAIN: Update development versions Apr 25, 2021
@chrisjsewell chrisjsewell changed the title 🔧 MAINTAIN: Update development versions 🔧 MAINTAIN: Update development packages Apr 25, 2021
@chrisjsewell chrisjsewell merged commit 53d9b33 into master Apr 25, 2021
@chrisjsewell chrisjsewell deleted the fix-setup-name branch April 25, 2021 23:26
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.

2 participants