classification
Title: Renaming Doc/reference/ to Doc/language/
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.7
process
Status: closed Resolution: rejected
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Mariatta, docs@python, eamanu, maggyero
Priority: low Keywords:

Created on 2019-08-09 09:38 by maggyero, last changed 2019-08-10 04:47 by Mariatta. This issue is now closed.

Messages (3)
msg349280 - (view) Author: Géry (maggyero) * Date: 2019-08-09 09:38
The page https://docs.python.org/3/ lists these two parts:

- Library Reference
- Language Reference

So both parts are "references".

However in the cpython GitHub repository, the Doc/ directory contains these two directories:

- library/
- reference/

So to be consistent, shouldn't we rename the Doc/reference/ directory to Doc/language/?
msg349324 - (view) Author: Emmanuel Arias (eamanu) * Date: 2019-08-10 01:40
Hello maggyero,

I thinks that could be a good improve. But this structure is
used on since old cpython versions, so I don't know if it will be a necessary change.

But, if you don't receive some feedback from here, you can propose
a PR, maybe other core dev could review it and tell you their opinion
:-)
msg349329 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2019-08-10 04:47
The change is not worth doing for several reasons:

- renaming filename/directory breaks git history on GitHub web UI. The history can still be viewed if you use the command line e.g. git log --follow. 
 
- other pages like stack overflow or blog posts have linked to the /reference for ages. We'll be breaking links. We might be able to set up redirect to the new path, but the effort is not worth the gain IMO.

There is very little to be gained compared to all the pitfalls.

So I'm closing this issue.

Thanks.
History
Date User Action Args
2019-08-10 04:47:14Mariattasetstatus: open -> closed
priority: normal -> low


nosy: + Mariatta
messages: + msg349329
resolution: rejected
stage: resolved
2019-08-10 01:40:11eamanusetnosy: + eamanu
messages: + msg349324
2019-08-09 09:39:06maggyerosettype: enhancement
2019-08-09 09:38:48maggyerocreate