This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: "Date" of what's new is confusing
Type: Stage: resolved
Components: Documentation Versions: Python 3.8, Python 3.7, Python 3.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: cheryl.sabella, docs@python, methane, ned.deily
Priority: normal Keywords: patch

Created on 2017-03-04 11:42 by methane, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 494 merged methane, 2017-03-05 23:50
PR 500 merged methane, 2017-03-06 08:01
PR 6093 merged ned.deily, 2018-03-13 01:11
PR 6094 merged ned.deily, 2018-03-13 01:12
Messages (16)
msg288976 - (view) Author: Inada Naoki (methane) * (Python committer) Date: 2017-03-04 11:42
See https://docs.python.org/3/whatsnew/3.6.html

At top:

:Release: |release|
:Date: |today|
:Editors: Elvis Pranskevichus <elvis@magic.io>, Yury Selivanov <yury@magic.io>

This |today| is replaced with day when HTML is build (like "Last updated:" in footer).  This is near to the date this page is modified last on docs.python.org, until clean rebuild happens.
But other cases, this shows only when this HTML is built.  It's confusing.

How about replacing |today| to Python 3.6.0 release date, or removing the ":Date: |today|" line?
msg288977 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2017-03-04 12:17
It's a bit confusing but:

1. https://docs.python.org/3/whatsnew/3.6.html

is the URL for the current 3.6 branch, in other words, what will be in the next 3.6 release.  These are rebuilt as changes are checked in.

2. https://docs.python.org/release/3.6.0/whatsnew/3.6.html

(which is linked from https://www.python.org/doc/versions/) is the URL for the docs corresponding to the 3.6.0 release.  These are built at release time and then never change.

Does that help?
msg288986 - (view) Author: Inada Naoki (methane) * (Python committer) Date: 2017-03-04 16:56
> is the URL for the current 3.6 branch, in other words, what will be in the next 3.6 release.

"next 3.6 release" means 3.6.1?

> These are rebuilt as changes are checked in.

There are some commit for fixing something after 3.6.0 released.
But I think rebuild can be happen without changing the page.  For example, major sphinx version up, fixing template, update version of imported js libraries.
And as I said, the document may be built on other machine. In this case, this |today| is not related to last commit date of this page. It seems unmeaningful.

So I still this ":Date:" should be release date, or removed.
msg289055 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2017-03-06 02:15
Sorry, I disagree.  I think the point of adding these directives is that shows for what release of 3.6.x they apply.  It is expected that the What's New documents may be updated during the lifecycle of a major release and having the release and date there lets the reader know that they are update.  For example, at the moment https://docs.python.org/3.6/whatsnew/3.6.html shows:

What’s New In Python 3.6
Release:	3.6.1rc1
Date:	March 05, 2017

which is correct.
msg289056 - (view) Author: Inada Naoki (methane) * (Python committer) Date: 2017-03-06 02:18
https://docs.python.org/3.7/whatsnew/3.6.html shows:
Release:	3.7.0a0
Date:	February 15, 2017

Is it make sense for you?
msg289057 - (view) Author: Inada Naoki (methane) * (Python committer) Date: 2017-03-06 02:20
Additonally, unlike "changelog", "What's New" only shows difference between 3.5 and 3.6.  It won't be updated to describe changes between 3.6.0 and 3.6.1.
msg289059 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2017-03-06 02:27
> Additonally, unlike "changelog", "What's New" only shows difference between 3.5 and 3.6.  It won't be updated to describe changes between 3.6.0 and 3.6.1.

That's not always true.  There are occasionally changes made in the What's New document for maintenance releases.  See, for example, https://docs.python.org/3.5/whatsnew/3.5.html.  You'll find references to 3.5.1 and 3.5.2 there.

If it's truly bothering people, a better solution is to just remove the release and date directives.  They aren't there for earlier releases.  We can live without them.
msg289060 - (view) Author: Inada Naoki (methane) * (Python committer) Date: 2017-03-06 02:28
I'm sorry, I was wrong.

https://docs.python.org/3.5/whatsnew/3.5.html

asyncio has "Updates in 3.5.1:" section.
provisional package will introduce updates in what's new in bugfix release.

So is it OK to just removing Date and Release field?
"Date (when this HTML is built)" and "Release (of branch this page is built)" are not good for "What's New In 3.6" page.
msg289061 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2017-03-06 02:29
Heh, it looks like we agree!
msg290118 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2017-03-24 20:09
New changeset 0acdea79cba3883c5e7035c7336fb0ce54435c03 by Ned Deily (INADA Naoki) in branch '3.6':
bpo-29719: Remove Date and Release field in whatsnew/3.6 (GH-500)
https://github.com/python/cpython/commit/0acdea79cba3883c5e7035c7336fb0ce54435c03
msg290292 - (view) Author: Inada Naoki (methane) * (Python committer) Date: 2017-03-24 22:50
New changeset 4e1a065c20856a00d0fe88ce022b249170608058 by INADA Naoki in branch '3.6':
bpo-29719: Remove Date and Release field in whatsnew/3.6 (GH-500)
https://github.com/python/cpython/commit/4e1a065c20856a00d0fe88ce022b249170608058
msg290293 - (view) Author: Inada Naoki (methane) * (Python committer) Date: 2017-03-24 22:51
New changeset 2225ddaa9e64c086b2b6997b0c9ac50921f7aa85 by INADA Naoki in branch 'master':
bpo-29719: Remove Date and Release field in whatsnew/3.6 (GH-494)
https://github.com/python/cpython/commit/2225ddaa9e64c086b2b6997b0c9ac50921f7aa85
msg313711 - (view) Author: Cheryl Sabella (cheryl.sabella) * (Python committer) Date: 2018-03-12 23:00
I believe this can be closed as 'fixed'?
msg313713 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2018-03-13 01:16
New changeset a34510a4c562b4b23c7f9da6ff6e2318484f5f1a by Ned Deily in branch 'master':
bpo-29719: Remove Date and Release field in whatsnew/3.7 and 8 (GH-6093)
https://github.com/python/cpython/commit/a34510a4c562b4b23c7f9da6ff6e2318484f5f1a
msg313714 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2018-03-13 01:16
New changeset d461ed84b57aae0bdccd117dc38109c087444d50 by Ned Deily in branch '3.7':
bpo-29719: Remove Date and Release field in whatsnew/3.7 (GH-6094)
https://github.com/python/cpython/commit/d461ed84b57aae0bdccd117dc38109c087444d50
msg313715 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2018-03-13 01:23
> I believe this can be closed as 'fixed'?

Well, it *was* fixed!  But then I reintroduced the boilerplate when I created the 3.7 and 3.8 whatsnew files - now fixed.  Thanks for the reminder!
History
Date User Action Args
2022-04-11 14:58:43adminsetgithub: 73905
2018-03-13 01:23:24ned.deilysetstatus: open -> closed

assignee: docs@python
components: + Documentation
versions: + Python 3.6, Python 3.7, Python 3.8
nosy: + docs@python

messages: + msg313715
resolution: fixed
stage: patch review -> resolved
2018-03-13 01:16:57ned.deilysetmessages: + msg313714
2018-03-13 01:16:12ned.deilysetmessages: + msg313713
2018-03-13 01:12:34ned.deilysetpull_requests: + pull_request5856
2018-03-13 01:11:29ned.deilysetkeywords: + patch
stage: patch review
pull_requests: + pull_request5855
2018-03-12 23:00:48cheryl.sabellasetnosy: + cheryl.sabella
messages: + msg313711
2017-03-24 22:51:34methanesetmessages: + msg290293
2017-03-24 22:50:58methanesetmessages: + msg290292
2017-03-24 20:09:32ned.deilysetmessages: + msg290118
2017-03-06 08:01:34methanesetpull_requests: + pull_request408
2017-03-06 02:29:08ned.deilysetmessages: + msg289061
2017-03-06 02:28:34methanesetmessages: + msg289060
2017-03-06 02:27:51ned.deilysetmessages: + msg289059
2017-03-06 02:20:02methanesetmessages: + msg289057
2017-03-06 02:18:41methanesetmessages: + msg289056
2017-03-06 02:15:40ned.deilysetmessages: + msg289055
2017-03-05 23:50:34methanesetpull_requests: + pull_request404
2017-03-04 16:56:55methanesetmessages: + msg288986
2017-03-04 12:17:26ned.deilysetnosy: + ned.deily
messages: + msg288977
2017-03-04 11:42:25methanecreate