classification
Title: Add link to 3.3 version in unicode howto
Type: enhancement Stage: resolved
Components: Documentation, Unicode Versions: Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: BreamoreBoy, chris.jerdonek, docs@python, eric.araujo, ezio.melotti, loewis, python-dev
Priority: normal Keywords: easy, patch

Created on 2012-10-14 09:30 by BreamoreBoy, last changed 2012-10-16 00:15 by chris.jerdonek. This issue is now closed.

Files
File name Uploaded Description Edit
issue-16227-1-27.patch chris.jerdonek, 2012-10-14 21:22
Messages (16)
msg172865 - (view) Author: Mark Lawrence (BreamoreBoy) * Date: 2012-10-14 09:30
For http://docs.python.org/howto/unicode.html (that's Python 2.7.3) and http://docs.python.org/release/3.1.5/howto/unicode.html the first paragraph states "(This HOWTO has not yet been updated to cover the 3.x versions of Python.)".  I suggest this is changed to read something like "Release 1.12 onwards of this document covers the 3.2 Python versions onwards."
msg172870 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2012-10-14 10:19
I wonder why the note must be there at all.  None of the 2.x docs have been updated to cover the 3.x versions of Python.  Otherwise, every 2.x page could use such a disclaimer.

Here is where the note was added:

http://hg.python.org/cpython/rev/bdef454f7212
msg172873 - (view) Author: Mark Lawrence (BreamoreBoy) * Date: 2012-10-14 10:54
I'd happily settle on seeing this historical note removed from the 2.7.3 docs.  I'm unsure about the best approach for 3.1.5.  Who's done the most work on unicode to answer this one, someone working on #16061 possibly?
msg172884 - (view) Author: Martin v. Löwis (loewis) * (Python committer) Date: 2012-10-14 13:56
I don't think there is a need to update the 3.1.x version of the documentation in that respect.
msg172885 - (view) Author: Martin v. Löwis (loewis) * (Python committer) Date: 2012-10-14 14:02
Before the disclaimer can be removed, all statements of the document should be reviewed. From a shallow glance, the section on "Python 2.x's support" should be changed to "Python's support". The reference to Marc-Andre Lemburg's presentation should be removed, as it's not current anymore.

The 2.7 version of the document is fine as it stands; it indeed doesn't talk about 3.x.
msg172886 - (view) Author: Mark Lawrence (BreamoreBoy) * Date: 2012-10-14 14:06
See also #4153
msg172898 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2012-10-14 18:29
> I don't think there is a need to update the 3.1.x version of the documentation in that respect.
> versions: +Python 3.3, Python 3.4 -Python 3.1

This issue was just about the 2.7 version.  3.x doesn't contain the language mentioned by the original commenter.  If 2.7 should not be changed, this issue should be closed.  Or are you suggesting other updates to the 3.x docs?
msg172900 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2012-10-14 18:34
> 3.x doesn't contain the language mentioned by the original commenter.

3.2 onwards I mean.
msg172904 - (view) Author: Martin v. Löwis (loewis) * (Python committer) Date: 2012-10-14 18:54
Ah, I missed that.

I'm skeptical that the proposed change is an improvement - how would the reader know how to find version 1.12 of the document? I'm also skeptical that removal of the note in 2.7 is useful: people finding the document in Google would misunderstand.

My proposal: "This version of the document talks about Unicode support in Python 2.x. See <URL> for the Python 3 version."
msg172907 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2012-10-14 19:48
That proposal sounds fine to me.
msg172909 - (view) Author: Mark Lawrence (BreamoreBoy) * Date: 2012-10-14 20:12
The mvl proposal fine by me too, thanks guys.
msg172923 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2012-10-14 21:22
Attaching proposed patch.
msg172927 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2012-10-14 22:01
I would not rephrase the first two lines.

Nice trick of using py3k in the link.
msg172929 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2012-10-14 22:06
> I would not rephrase the first two lines.

Why not?  The current language focuses on the negative ("explaining problems") while we prefer an affirmative tone:

http://docs.python.org/devguide/documenting.html#affirmative-tone
msg173005 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2012-10-16 00:13
New changeset c59884f4bc8d by Chris Jerdonek in branch '2.7':
Issue #16227: Add to 2.x Unicode HOWTO a link to the Python 3 version.
http://hg.python.org/cpython/rev/c59884f4bc8d
msg173006 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2012-10-16 00:15
Committed without changing the first sentence, as Éric preferred.

Thanks for the report, Mark!
History
Date User Action Args
2012-10-16 00:15:11chris.jerdoneksetstatus: open -> closed
resolution: fixed
messages: + msg173006

stage: needs patch -> resolved
2012-10-16 00:13:04python-devsetnosy: + python-dev
messages: + msg173005
2012-10-14 22:06:06chris.jerdoneksetmessages: + msg172929
2012-10-14 22:01:20eric.araujosetmessages: + msg172927
2012-10-14 21:22:56chris.jerdoneksetfiles: + issue-16227-1-27.patch
keywords: + patch
messages: + msg172923
2012-10-14 20:31:19eric.araujosetkeywords: + easy
nosy: + eric.araujo

stage: needs patch
title: Change unicode howtos as misleading -> Add link to 3.3 version in unicode howto
2012-10-14 20:12:50BreamoreBoysetmessages: + msg172909
2012-10-14 19:48:36chris.jerdoneksetmessages: + msg172907
2012-10-14 18:54:59loewissetmessages: + msg172904
versions: + Python 2.7, - Python 3.2, Python 3.3, Python 3.4
2012-10-14 18:34:12chris.jerdoneksetmessages: + msg172900
2012-10-14 18:29:58chris.jerdoneksetmessages: + msg172898
2012-10-14 14:19:00ezio.melottisetnosy: + ezio.melotti
components: + Unicode
2012-10-14 14:06:53BreamoreBoysetmessages: + msg172886
2012-10-14 14:02:56loewissetmessages: + msg172885
versions: - Python 2.7
2012-10-14 13:56:00loewissetnosy: + loewis

messages: + msg172884
versions: + Python 3.3, Python 3.4, - Python 3.1
2012-10-14 10:54:09BreamoreBoysetmessages: + msg172873
2012-10-14 10:19:19chris.jerdoneksetnosy: + chris.jerdonek
messages: + msg172870
2012-10-14 09:30:04BreamoreBoycreate