[issue18855] Inconsistent README filenames

[Mariatta Wijaya]

Mariatta Wijaya  added the comment:

Thanks. I'm going to reject this and to keep the readme files as is.
The consequence of renaming files, now that we are on GitHub, is that GitHub 
doesn't retain the complete file history.
So while on GitHub, clicking the file's "History" will only show the history of 
the file after the rename.
In addition, locally you need to do `git log --follow` to see the complete 
history.
I find that to be an inconvenience.

--
nosy: +Mariatta
resolution:  -> rejected
stage: needs patch -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18855] Inconsistent README filenames

[Cheryl Sabella]

Change by Cheryl Sabella :


--
versions: +Python 3.8 -Python 3.5

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18855] Inconsistent README filenames

[Berker Peksag]

Changes by Berker Peksag berker.pek...@gmail.com:


--
keywords: +easy
stage:  - needs patch
versions: +Python 3.5 -Python 3.4

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue18855
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18855] Inconsistent README filenames

[Éric Araujo]

Éric Araujo added the comment:

I’ve had co-workers get in trouble with file renames and case sensitivity on 
Mac OS X, but I’ve always been able to fix issues on Debian and tell them to hg 
pull --update.  I don’t remember if they had to create a new clone, or update 
to an older revision without the troublemaking files.

Anyhow, I don’t think this bug is important.  +0 for renaming the README to 
README.txt and configuring hgeol to make end-of-lines native.  That would solve 
the problem of a potential new contributor on Windows cloning the repo and not 
sure how to read the readme file at the repo root.  Changing the case of the 
readme.txt files would not solve any problem.

--

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue18855
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18855] Inconsistent README filenames

[Georg Brandl]

Georg Brandl added the comment:

AFAIR renaming the lowercased versions might lead to trouble with hg on 
case-insensitive file systems. Anyone know if that's still the case?

Otherwise README.txt is fine.  Although, Windows users will then complain about 
the Unix-style line endings because the files will be opened with Notepad by 
default :|

--
nosy: +georg.brandl

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue18855
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18855] Inconsistent README filenames

[Mike Hoy]

Changes by Mike Hoy mho...@gmail.com:


--
nosy: +mikehoy

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue18855
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18855] Inconsistent README filenames

[Terry J. Reedy]

Terry J. Reedy added the comment:

README.txt is also used in lib/idlelib and lib/idlelib/idle_test. In the latter 
case, I was told to use this.

--
nosy: +terry.reedy

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue18855
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18855] Inconsistent README filenames

[Tshepang Lekhonkhobe]

Changes by Tshepang Lekhonkhobe tshep...@gmail.com:


--
nosy: +tshepang

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue18855
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18855] Inconsistent README filenames

[Ezio Melotti]

Changes by Ezio Melotti ezio.melo...@gmail.com:


--
nosy: +eric.araujo, ezio.melotti, tim.peters
type:  - enhancement

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue18855
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18855] Inconsistent README filenames

[Madison May]

New submission from Madison May:

Is there any reason (other than backwards compatibility) that the names of 
README files are inconsistent?

README: 3 instances - root, /Mac, /Misc, /Tools
readme.txt: 2 instances - /PC, /PCbuild
README.txt: 1 instance - /Doc

--
assignee: docs@python
components: Documentation
messages: 196299
nosy: docs@python, madison.may
priority: normal
severity: normal
status: open
title: Inconsistent README filenames

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue18855
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18855] Inconsistent README filenames

[Antoine Pitrou]

Antoine Pitrou added the comment:

No reason really. We could standardize all of them on README.txt, perhaps.

--
nosy: +pitrou
priority: normal - low
versions: +Python 3.4

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue18855
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18855] Inconsistent README filenames

[Madison May]

Madison May added the comment:

It's obviously low priority, just thought I would mention it.  I found it a bit 
odd that README is used, though, since that means users will likely have to 
select the program they want to use to open the file (in Windows, at least).  

It might also be nice to follow the standard distutils idiom. From Éric Araujo 
on issue11913, 

In packaging/distutils2, the recommended idiom looks like this (in setup.cfg):

[metadata]
description-file = README.whatever

In other words, README.txt would work nicely.

--

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue18855
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com