Issues

Issue #3155 resolved

Accommodate plaintext READMEs in Python repos (BB-2892)

David Chambers
created an issue

For non-Python repositories, naming the file "README" or "README.txt" does the job, but for Python repos these are treated as reStructuredText. This forces users to remove the language selection or use a nonstandard file name in order to have a README treated as plaintext.

Comments (6)

  1. David Chambers reporter

    Here's the story behind the special treatment of Python READMEs…

    PyPI assumes that a file named “README” or “README.txt” represents a reStructuredText README. For compatibility with PyPI, Bitbucket makes the same assumption. The downside of this, though, is that it's not possible to indicate that a plaintext README in a Python repo should be treated as such.

  2. Log in to comment