[SciPy-user] Docstring standards for NumPy and SciPy

Ivan Vilata i Balaguer ivilata at carabos.com
Sun Jan 21 11:01:44 CST 2007


Robert Kern (el 2007-01-20 a les 07:10:21 -0600) va dir::

> There's another thing we should standardize that's related to docstrings:
> encoding. Many names of authors of modules as well as authors of papers I want
> to cite in the docstrings have non-ASCII characters. Let's standardize on a
> UTF-8 encoding for all files that have non-ASCII characters.

Wouldn't it be safer and more cross-platform friendly to use Unicode
docstrings with escape sequences where needed, instead of hard-wiring
the UTF-8 encoding into docstrings?  This would keep the files ASCII,
and I guess there won't be a need for that many non-ASCII characters
(occasionaly for author names, as you pointed out).    ::

> Now, having gone that far, I'm sitting on the fence as to whether we should
> discourage/encourage/leave alone the idea of using the math symbols in Unicode
> to help display math better.

I guess that, with so many non-obvious Unicode math characters, one
would better use LaTeX or plain ASCII math to get consistent math
notation from different authors. ;)

Just my impressions.  Cheers,

::

	Ivan Vilata i Balaguer   >qo<   http://www.carabos.com/
	       Cárabos Coop. V.  V  V   Enjoy Data
	                          ""
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 309 bytes
Desc: Digital signature
Url : http://projects.scipy.org/pipermail/scipy-user/attachments/20070121/7e6f264c/attachment.bin 


More information about the SciPy-user mailing list