Roundup Robot added the comment:
New changeset 0646eee8296a by Nick Coghlan in branch '3.4':
Issue 19548: update codecs module documentation
https://hg.python.org/cpython/rev/0646eee8296a
New changeset 4d00d0109147 by Nick Coghlan in branch 'default':
Merge issue 19548 changes from 3.4
Nick Coghlan added the comment:
Thanks for the work on this folks, both Jan for the feedback, Martin for the
writing, and everyone else for their comments.
I don't believe we addressed all of Jan's comments, but I'd like to request
that any further comments be filed as separate issues, now
Martin Panter added the comment:
Thanks Nick. Here is a small followup patch for the default (3.5) branch to
keep things consistent.
--
Added file: http://bugs.python.org/file37618/default-branch-followup.patch
___
Python tracker
Roundup Robot added the comment:
New changeset 20a5a56ce090 by Nick Coghlan in branch 'default':
Issue #19548: clean up merge issues in codecs docs
https://hg.python.org/cpython/rev/20a5a56ce090
--
___
Python tracker rep...@bugs.python.org
Nick Coghlan added the comment:
Thanks for the follow-up patch Martin - I missed those when I did the merge
forward from 3.4.
--
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue19548
___
Martin Panter added the comment:
Adding patch v5, for the 3.4 branch. There is at least one reference that still
needs fixing in the default branch that is not applicable to the 3.4 branch.
Main changes from Nick’s patch:
* Removed sentence now redundant with introduction to open() and
Nick Coghlan added the comment:
I started making a few edits based on Zuo and Walter's comments while getting
this patch ready for merging, and decided the end result could benefit from an
additional round of feedback before committing it.
This particular patch is also aimed at the Python 3.4
Martin Panter added the comment:
Adding patch v2 after learning how to compile the docs and fixing my errors. I
also simplified the descriptions of the CodecInfo attributes by defering the
constructor signatures to where they are fully defined under “Codec base
classes”, and merged the list
Nick Coghlan added the comment:
Thanks for those drafts, Martin - they look like a strong improvement to me.
While I still had plenty of comments/questions on v2, I think that's more a
reflection on how long it has been since we gave these docs a thorough overall
review, moreso than a
Changes by Ezio Melotti ezio.melo...@gmail.com:
--
nosy: +ezio.melotti
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue19548
___
___
Martin Panter added the comment:
New patch version addressing many of the comments; thanks for reviewing! Also
adds and extends some unit tests to confirm some of the corner cases I am
documenting.
--
Added file: http://bugs.python.org/file37530/codecs-doc.v3.patch
Changes by Serhiy Storchaka storch...@gmail.com:
--
stage: - needs patch
type: - enhancement
versions: +Python 2.7, Python 3.5 -Python 3.3
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue19548
Martin Panter added the comment:
Here is a patch addressing many of the points raised. Please have a look and
give any feedback. Beware I am not very familiar with the Restructured Text
markup and haven’t tried compiling it.
1. Mentioned bytes-to-bytes and text-to-text in general right at the
Changes by Berker Peksag berker.pek...@gmail.com:
--
nosy: +berker.peksag
stage: needs patch - patch review
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue19548
___
Zoinkity . added the comment:
One glaring omission is any information about multibyte codecs--the class, its
methods, and how to even define one.
Also, the primary use for codecs.register would be to append a single codec to
the lookup registry. Simple usage of the method only provides
Changes by Mark Lawrence breamore...@yahoo.co.uk:
--
nosy: -BreamoreBoy
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue19548
___
___
Martin Panter added the comment:
Addition to the list of improvements:
* Under codecs.IncrementalEncoder.reset() it mentions calling encode('',
final=True). This call does not work as written for the byte encoders in my
experience, because they do not accept empty text strings. Perhaps it
Changes by Serhiy Storchaka storch...@gmail.com:
--
nosy: +doerwalter
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue19548
___
___
Python-bugs-list
Nick Coghlan added the comment:
Another big one: the encodings module API is not documented in the prose docs,
and nor is the interface between the default search function and the individual
encoding definitions. There's some decent info in help(encoding) though.
The interaction with the
Marc-Andre Lemburg added the comment:
On 16.11.2013 14:25, Nick Coghlan wrote:
Nick Coghlan added the comment:
Another big one: the encodings module API is not documented in the prose
docs, and nor is the interface between the default search function and the
individual encoding
Mark Lawrence added the comment:
Could they be documented with a massive warning in red Cpython implementation
detail - subject to change without notice? Or documented in a place that is
only accessible to developers and not users? Or...???
--
nosy: +BreamoreBoy
Marc-Andre Lemburg added the comment:
On 16.11.2013 15:03, Mark Lawrence wrote:
Mark Lawrence added the comment:
Could they be documented with a massive warning in red Cpython
implementation detail - subject to change without notice? Or documented in
a place that is only accessible to
Nick Coghlan added the comment:
On 16 November 2013 23:33, Marc-Andre Lemburg rep...@bugs.python.org wrote:
On 16.11.2013 14:25, Nick Coghlan wrote:
Those were not documented on purpose, since they are an implementation
detail of the encodings package search function.
If you document them
Changes by Terry J. Reedy tjre...@udel.edu:
--
versions: -Python 3.2
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue19548
___
___
Python-bugs-list
New submission from Jan Kaliszewski:
When learning about the 'codecs' module I encountered several places in the
docs of the module that, I believe, could be improved to be clearer and easier
for codecs-begginers:
1. Ad `codecs.encode` and `codecs.decode` descriptions: I believe it would be
Jan Kaliszewski added the comment:
s/world/word
s/begginers/beginners
(sorry, it's late night here)
--
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue19548
___
Jan Kaliszewski added the comment:
8. Again ad `codecs.open`: the default file mode is actually 'rb', not 'r'.
9. Several places in the docs -- ad: `codecs.register_error`, `codecs.open`,
`codecs.EncodedFile`, `Codec.encode/decode`, `codecs.StreamWriter/StreamReader`
-- do not cover cases of
Jan Kaliszewski added the comment:
11. Ad encoding 'undefined': The sentence `Can be used as the system encoding
if no automatic coercion between byte and Unicode strings is desired.` was
suitable for Python 2.x, but not for Python 3.x'. I believe, this sentence
should be removed.
--
Changes by Jan Kaliszewski z...@chopin.edu.pl:
--
versions: -Python 2.6, Python 2.7, Python 3.1
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue19548
___
Changes by Ned Deily n...@acm.org:
--
nosy: +ncoghlan
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue19548
___
___
Python-bugs-list mailing list
Nick Coghlan added the comment:
A few more:
- codec name normalisation (lower case, space to hyphen) is not mentioned
in the codecs.register description
- search function registration is not reversible, which doesn't play well
with module reloading
- codecs.CodecInfo init signature is not
31 matches
Mail list logo
