[docs] [issue18697] Unify arguments names in Unicode object C API documentation

Matheus Vieira Portela report at bugs.python.org
Tue Sep 1 01:03:57 CEST 2015


Matheus Vieira Portela added the comment:

Just checking, it would be required to update Objects/unicodeobject.c, Include/unicodeobject.h, and Doc/c-api/unicode.rst, right?

As far as I saw, "unicode" means a Python object with unicode string, "u" is a UTF-8 encoded C string, "str" and "s" are encoded C strings (UTF-8, UTF-7, ASCII, Latin-1, among others). Is it alright to rename Python unicode objects to "unicode" and the others to simply "str"? These names are more meaningful than the single character alternatives.

The same logic would be applied to the other types, always keeping the longer name rather than the single character ones.

----------
nosy: +matheus.v.portela

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue18697>
_______________________________________


More information about the docs mailing list