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

[DOC] Use README as long_desc #595

Merged
merged 3 commits into from
Aug 26, 2020
Merged

[DOC] Use README as long_desc #595

merged 3 commits into from
Aug 26, 2020

Conversation

emdupre
Copy link
Member

@emdupre emdupre commented Aug 20, 2020

Closes #472.

Changes proposed in this pull request:

  • Uses the README text as the package "long description," which currently reads as "To do."
  • The long description can be seen on PyPi here.

@tsalo
Copy link
Member

tsalo commented Aug 20, 2020

Closes None 😞

Nonsense. It closes #472!

@codecov
Copy link

codecov bot commented Aug 20, 2020

Codecov Report

Merging #595 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #595   +/-   ##
=======================================
  Coverage   93.53%   93.53%           
=======================================
  Files          26       26           
  Lines        1965     1965           
=======================================
  Hits         1838     1838           
  Misses        127      127           

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 387db31...819f43a. Read the comment docs.

@tsalo
Copy link
Member

tsalo commented Aug 20, 2020

Does the README need to be in the manifest file or anything for this to work for the deployed package?

@emdupre
Copy link
Member Author

emdupre commented Aug 20, 2020

I don't think so. I'm basing this idea off of Jupyter Book, and their manifest doesn't include their README !

@emdupre emdupre requested review from eurunuela and jbteves August 23, 2020 15:49
Copy link
Collaborator

@jbteves jbteves left a comment

Choose a reason for hiding this comment

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

Glad to get rid of a todo. Thanks @emdupre !

@emdupre
Copy link
Member Author

emdupre commented Aug 26, 2020

Thanks, everyone ! Merging 🚀

@emdupre emdupre merged commit 150b5c0 into master Aug 26, 2020
@tsalo tsalo deleted the doc/long-desc branch March 9, 2021 15:40
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.

Add long description to package metadata
3 participants