-
Notifications
You must be signed in to change notification settings - Fork 985
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
Add icon for change log etc project URL #7882
Conversation
Thanks @scop! |
Background info at pypi/warehouse#7882
Background info at pypi/warehouse#7882 (comment)
Background info at pypi/warehouse#7882 (comment)
Background info at pypi/warehouse#7882 (comment)
Background info at pypi/warehouse#7882 (comment)
Background info at pypi/warehouse#7882 (comment)
Background info at pypi/warehouse#7882 (comment)
Background info at pypi/warehouse#7882
Background info at pypi/warehouse#7882 (comment)
Background info at pypi/warehouse#7882 (comment)
Background info at pypi/warehouse#7882
Background info at pypi/warehouse#7882 (comment)
Background info at pypi/warehouse#7882 (comment)
Background info at pypi/warehouse#7882
@@ -21,6 +21,8 @@ | |||
{% set icon = "fas fa-cloud-download-alt" %} | |||
{% elif name|lower in ["home", "homepage", "home page"] %} | |||
{% set icon = "fas fa-home" %} | |||
{% elif name|lower in ["changelog", "change log", "changes", "release notes", "news", "what's new"] %} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@scop I often use category prefixes for links. See https://pypi.org/project/aiohttp/. So it'd be better to match if any of these are in the name and not just match exactly. In this case, I'd rather use Docs: changelog
to follow the same style as Docs: RTD
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm sure the warehouse maintainers would consider such a PR :)
BTW, are these recognised names documented anywhere? Or even just one preferred form for each category? As a project maintainer, it would be good to be able to see at a glance what names I should use, because you're never going to cover every possibility. |
@takluyver Not yet: #5947 |
* Add change log project URL Background info at pypi/warehouse#7882 (comment)
Background info at pypi/warehouse#7882 (comment)
Background info at pypi/warehouse#7882
Background info at pypi/warehouse#7882
Background info at pypi/warehouse#7882 (comment)
Getting to package change logs, release notes or the like is currently a manual task, as links to them are not defined just about anywhere except perhapse in description prose. I think it would be good to promote adding them.
For example, when I see a new release from a project RSS feed being made, I go to PyPI and... start manually sifting through pages here and there to find what's changed in the release. Would be very nice to have a direct link in project links for that.
Although this is beyond PyPI, adding a recognizable specific icon could be a step towards that direction.