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

use the regular readme for the long description #2866

Merged

Conversation

graingert
Copy link
Member

No description provided.

Copy link

codecov bot commented Nov 5, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (78c55aa) 99.64% compared to head (013ac66) 99.64%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2866   +/-   ##
=======================================
  Coverage   99.64%   99.64%           
=======================================
  Files         117      117           
  Lines       17634    17634           
  Branches     3172     3172           
=======================================
  Hits        17572    17572           
  Misses         43       43           
  Partials       19       19           

@A5rocks
Copy link
Contributor

A5rocks commented Nov 6, 2023

Personally I like having a customized version of README for pypi even if it has caused issues due be being out of sync in the past.

(people seeing trio in pypi have different goals than people seeing trio on github. but idk if we adequately address that as is...)

@Fuyukai
Copy link
Member

Fuyukai commented Nov 6, 2023

Genuinely, do people ever actually read the pypi readmes? I nearly always just click through to the repository instead (usually because the readme is outdated and wrong).

@A5rocks
Copy link
Contributor

A5rocks commented Nov 6, 2023

-snip- huh I can't find an archived page to support my memory so I was probably just misremembering. But I do think I agree that they aren't looked at much...

Copy link
Contributor

@A5rocks A5rocks left a comment

Choose a reason for hiding this comment

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

OK I've come around on this, I agree with @Fuyukai that nobody really looks at these and that any upkeep burden is too much.

Comment on lines +55 to 56
file = "README.rst"
content-type = "text/x-rst"
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we really need to specify content-type?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think it's best practice, but I am not certain.

Copy link
Contributor

@CoolCat467 CoolCat467 left a comment

Choose a reason for hiding this comment

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

I think this makes sense

@Fuyukai Fuyukai merged commit accaae4 into python-trio:master Feb 20, 2024
30 checks passed
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.

None yet

4 participants