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

Add icon for change log etc project URL #7882

Merged
merged 2 commits into from
May 4, 2020
Merged

Add icon for change log etc project URL #7882

merged 2 commits into from
May 4, 2020

Conversation

scop
Copy link
Contributor

@scop scop commented May 2, 2020

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.

@di di merged commit 2f00f4a into pypi:master May 4, 2020
@di
Copy link
Member

di commented May 4, 2020

Thanks @scop!

@scop scop deleted the changelog-icon branch May 5, 2020 06:30
scop added a commit to scop/django-stubs that referenced this pull request May 5, 2020
scop added a commit to scop/huawei-lte-api that referenced this pull request May 5, 2020
scop added a commit to scop/huawei-lte-api that referenced this pull request May 5, 2020
scop added a commit to scop/mypy that referenced this pull request May 5, 2020
cooperlees pushed a commit to PyCQA/flake8-bugbear that referenced this pull request May 5, 2020
scop added a commit to scop/url-normalize that referenced this pull request May 5, 2020
scop added a commit to scop/python-rflink that referenced this pull request May 5, 2020
sobolevn pushed a commit to typeddjango/django-stubs that referenced this pull request May 5, 2020
Nurdok pushed a commit to PyCQA/pydocstyle that referenced this pull request May 5, 2020
atodorov pushed a commit to pylint-dev/pylint-django that referenced this pull request May 5, 2020
ericwb pushed a commit to PyCQA/bandit that referenced this pull request May 5, 2020
aequitas pushed a commit to aequitas/python-rflink that referenced this pull request May 5, 2020
scop added a commit to scop/pre-commit that referenced this pull request May 5, 2020
PCManticore pushed a commit to pylint-dev/pylint that referenced this pull request May 6, 2020
@@ -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"] %}
Copy link
Member

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.

Copy link
Contributor Author

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 :)

@takluyver
Copy link
Contributor

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.

@di
Copy link
Member

di commented May 16, 2020

@takluyver Not yet: #5947

kislyuk pushed a commit to kislyuk/argcomplete that referenced this pull request Sep 27, 2020
* Add change log project URL

Background info at
  pypi/warehouse#7882 (comment)
hauntsaninja pushed a commit to python/mypy that referenced this pull request Sep 27, 2020
mikespallino pushed a commit to mikespallino/bandit that referenced this pull request Aug 25, 2021
mikespallino pushed a commit to mikespallino/bandit that referenced this pull request Jan 7, 2022
busgaidw2 added a commit to busgaidw2/flake8-bugbear that referenced this pull request Aug 6, 2024
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.

4 participants