[New-bugs-announce] [issue1944] Documentation for PyUnicode_AsString (et al.) missing.

[Alexandre Vassalotti]

New submission from Alexandre Vassalotti:

I was wandering whether the pointer returned by PyUnicode_AsString needs
to be freed after usage (It turned it doesn't since the result is
cached). However, I found out that there isn't any documentation on
docs.python.org about the PyUnicode_AsString and
PyUnicode_AsStringAndSize functions. Although, both are documented in
the public unicodeobject.h header.

I notice that the documentation for several other unicode functions is
missing. Quickly, I see:

  PyUnicode_Resize
  PyUnicode_InternImmortal
  PyUnicode_GetDefaultEncoding
  PyUnicode_SetDefaultEncoding
  PyUnicode_BuildEncodingMap
  PyUnicode_FromFormatV
  PyUnicode_*UTF7*
  PyUnicode_AsEncodedObject
  PyUnicode_FromOrdinal
  PyUnicode_DecodeFSDefault
  PyUnicode_DecodeFSDefaultAndSize

It would probably be a good idea to polish up the documentation for
PyUnicode as much as possible for Python 3000, since extension
developers will certainly need to refer to it a lot during the
transition from 2.x.

----------
components: Documentation
keywords: easy
messages: 61734
nosy: alexandre.vassalotti
severity: normal
status: open
title: Documentation for PyUnicode_AsString (et al.) missing.
versions: Python 3.0

__________________________________
Tracker <report at bugs.python.org>
<http://bugs.python.org/issue1944>
__________________________________