[issue11840] Improvements to c-api/unicode documentation
New submission from Sandro Tosi
Sandro Tosi
Changes by STINNER Victor
Marc-Andre Lemburg
Sandro Tosi
added the comment: In addition, is there a reason for the sorting of UTF-8 UTF-32 UTF-16 and UTF-7 sections? why not alphabetically?
No particular reason. Alphabetical order would be just as good. Note that such changes would have to be backported in order to keep the merge conflicts to a minimum.
Also, several parts of the doc would need paragraph re-indentation (not done in this patch due to clarity).
Not sure what you mean here.
----------
nosy: +lemburg
_______________________________________
Python tracker
Marc-Andre Lemburg
New submission from Sandro Tosi
: Hi, After reading tomo cocoa mail at docs@ I gave a look at c-api/unicode file and fixed some minor editing issues.
Thanks. Looks good !
----------
_______________________________________
Python tracker
Sandro Tosi
Sandro Tosi wrote:
Sandro Tosi
added the comment: In addition, is there a reason for the sorting of UTF-8 UTF-32 UTF-16 and UTF-7 sections? why not alphabetically?
No particular reason. Alphabetical order would be just as good.
Note that such changes would have to be backported in order to keep the merge conflicts to a minimum.
It applies cleanly on 3.2 (module some offsets), not as good on 3.1 and 2.7: do you want me to prepare patches specifically for those 2 brances?
Also, several parts of the doc would need paragraph re-indentation (not done in this patch due to clarity).
Not sure what you mean here.
sorry, I meant wrap at 80th column (or so) :)
Cheers.
--
Sandro Tosi (aka morph, morpheus, matrixhasu)
My website: http://matrixhasu.altervista.org/
Me at Debian: http://wiki.debian.org/SandroTosi
----------
_______________________________________
Python tracker
Marc-Andre Lemburg
Sandro Tosi
added the comment: On Tue, Apr 12, 2011 at 23:34, Marc-Andre Lemburg
wrote: Sandro Tosi wrote:
Sandro Tosi
added the comment: In addition, is there a reason for the sorting of UTF-8 UTF-32 UTF-16 and UTF-7 sections? why not alphabetically?
No particular reason. Alphabetical order would be just as good.
Note that such changes would have to be backported in order to keep the merge conflicts to a minimum.
It applies cleanly on 3.2 (module some offsets), not as good on 3.1 and 2.7: do you want me to prepare patches specifically for those 2 brances?
I think you misunderstood: when reorganizing the contents of a file, it's better to apply the patch to all branches, rather than just the current, since otherwise future patches that do have to be merged to all branches would cause lots of merge conflicts.
Also, several parts of the doc would need paragraph re-indentation (not done in this patch due to clarity).
Not sure what you mean here.
sorry, I meant wrap at 80th column (or so) :)
Ah, ok.
That's the same category of change as the reorg above
(due to diff working line-based and not word based).
Such changes are fine, but should only be applied occasionally
and then preferably as one big commit to minimize disruption.
----------
_______________________________________
Python tracker
Changes by Ezio Melotti
Ezio Melotti
Sandro Tosi
Marc-Andre Lemburg
added the comment: I think you misunderstood: when reorganizing the contents of a file, it's better to apply the patch to all branches, rather than just the current, since otherwise future patches that do have to be merged to all branches would cause lots of merge conflicts.
the problem is: the file Doc/c-api/unicode.rst is already different between all the "open" branches. I'll provide patches for each of them, or specify where the patch can be merged (and from where).
Ezio Melotti
added the comment: Rewrapping the paragraphs you are changing is fine, the others can be left as they are.
Once I was told not to, since in this case it will hide the changes I made in between the rewrap.
Patches should be against the oldest branch where they can be applied, and since this is a doc patch it can go in 2.7 and 3.1 too.
I'm just about to prepare patches for all the supported branches
(where a merge is not possible).
----------
_______________________________________
Python tracker
Changes by Sandro Tosi
Changes by Sandro Tosi
Sandro Tosi
Roundup Robot
Roundup Robot
Ezio Melotti
Changes by Ezio Melotti
participants (5)
-
Ezio Melotti
-
Marc-Andre Lemburg
-
Roundup Robot
-
Sandro Tosi
-
STINNER Victor