Removed strange (updating-requirements)= from README.md

jazzband / pip-tools

A set of tools to keep your pinned Python dependencies fresh.

https://pip-tools.rtfd.io

BSD 3-Clause "New" or "Revised" License

7.6k stars 607 forks source link

Removed strange (updating-requirements)= from README.md #2084

Closed denisSurkov closed 2 months ago

denisSurkov commented 2 months ago

Removed strange (updating-requirements)=

Contributor checklist

[x] Included tests for the changes.
[x] PR title is short, clear, and ready to be included in the user-facing changelog.

Maintainer checklist

[ ] Verified one of these labels is present: backwards incompatible, feature, enhancement, deprecation, bug, dependency, docs or skip-changelog as they determine changelog listing.
[ ] Assign the PR to an existing or new milestone for the target version (following Semantic Versioning).

WhyNotHugo commented 2 months ago

It doesn't look like the README is rendered with MyST. The string (updating-requirements)= is just rendered as a regular paragraph on GitHub.

webknjaz commented 2 months ago

Yep. GitHub uses its own flavor — GFM. But this document is also used in Sphinx. GH is known for breaking rendering, though (they recently broke RST even more than before..). So I don't really care about this. I think it's better to have nicer docs on RTD where we have full control over the markup. That includes the changelog (which is currently isn't even displayed there, I think).

One way to solve this would be to remove most of the README and link the Sphinx docs but that would remove the ability to see so much content on the GH repo front page.

denisSurkov commented 2 months ago

Well, that's true. @webknjaz , sorry I didn't check it beforehand. I'll close PR.

https://pip-tools.readthedocs.io/en/stable/#updating-requirements

no strange string in docs

webknjaz commented 2 months ago

FTR this is something to be discussed, clearly. And if someone would like to offer different opinions and implementation suggestions, I won't be in a way. Of course, it'll mean taking on more maintenance responsibility in this specific area of the project. I just wanted to document why things are as they are today so that it could be taken into account in the future. Not many people were involved in plugging in Sphinx and then MyST so it may not be obvious to an average contributor.

WhyNotHugo commented 2 months ago

I wasn't aware the sphinx was including the README. Thanks for your clarity.