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

Sync PyPi package description with Github README #3552

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from

Conversation

jicruz96
Copy link

closes #3452

The reason your PyPi Project Page is out of sync is because of an out-dated hard-coded description in your setup.py file. To fix it:

  • setup.py now uses the project README text for long_description
  • All README image paths have been updated to their respective HTTP urls.

@jicruz96
Copy link
Author

unrelated to this PR, I started a conversation in the Google Groups Gensim forum (as recommended by your contribution guidelines when opening new issues) asking if working on adding type hints to gensim would be welcome work, but I haven't gotten any response. Just pinging that again here.

@piskvorky
Copy link
Owner

piskvorky commented Jul 18, 2024

setup.py now uses the project README text for long_description

IIRC setup.py (PyPI) used to required the RST format, whereas our README uses the Markdown format. That's why we kept two different descriptions, with just a stub (RST) for PyPI.

If that's no longer the case and setup.py now supports markdown (which it apparently does), that's great. That simplifies things. Thanks for the PR!

setup.py Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@piskvorky piskvorky added documentation Current issue related to documentation housekeeping internal tasks and processes labels Jul 18, 2024
@piskvorky piskvorky added this to the Summer 2024 release milestone Jul 18, 2024
@jicruz96 jicruz96 requested a review from piskvorky July 22, 2024 14:32
Copy link
Collaborator

@mpenkov mpenkov left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Current issue related to documentation housekeeping internal tasks and processes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Broken documentation links on Gensim's PyPI page
3 participants