tornado-zh icon indicating copy to clipboard operation
tornado-zh copied to clipboard

关于中文 docstring 标准

Open ladrift opened this issue 9 years ago • 1 comments

关于中文 doctoring,是否需要使用Unicode string?根据 PEP 0257

... For Unicode docstrings, use u"""Unicode triple-quoted strings""" .

之前的翻译中,符号标点均是英文标点,是否应该用中文标点更好?这样在网页上的显示效果会比英文标点混合中文更好。

untitled

上图截图自 https://tornado-zh.readthedocs.org/zh/latest/guide/async.html 页面。可以看出,中文标点会更好一点。

ladrift avatar Feb 29 '16 02:02 ladrift

恩, 使用Unicode string吧. 之前的翻译的部分我会进行修改的~

关于中文标点的问题,我个人比较倾向于继续使用英文标点后加一个空格异步, 非阻塞 而不是 异步,非阻塞 这样的. 不过我确实没有比较过在这个文档中两者的显示效果~ 看起来确实使用中文标点显示效果要好一些, 那就使用中文标点来吧~ 毕竟是给人阅读的, 显示效果也比较重要~ 感谢提醒 :)

tao12345666333 avatar Feb 29 '16 04:02 tao12345666333