很久以来,Python作为一个自由编程语言,其文档被认为是好。这有好多的原因, 最重要是Python 的创作者, Guido van Rossum, 早期承担义务来提供语言和有关的库的文档以及用户社区的持续介入为创建和维护文档方面提供帮助。
为了文档能更加完善或更加易使用, 社区的介入启用多种方式, 从写作到对缺陷报告以及简单抱怨。
这个文件是针对Python文档的作者和其潜力作者。更具体地, 它是针对那些使用同样工具,致力贡献标准文档和开发附加的文档的人。这个指南将对那些使用Python文档工具,用于非Python题目的作者,用途不大。同样对那些不是使用这工具的作者也没多大用。。
如果您的兴趣是对Python文档做贡献,但您没有时间或不打算学reStructuredText以及这里附带的标注结构 , 同样您作为Python贡献者也有一个受欢迎的地方。任何时候,您认为您能使现有的文档更通俗易懂或提供没有的文档, 现有的文献团队将乐意地与您集成您的文字,为你提供标注。请不要让这个文档的材料阻止你写文档和提供帮助的渴望。
关于本评注系统
本站使用上下文关联的评注系统来收集反馈信息。不同于一般对整章做评注的做法, 我们允许你对每一个独立的“文本块”做评注。一个“文本块”看起来是这样的:
一个“文本块”是一个段落,一个列表项,一段代码,或者其他一小段内容。 你选中它会高亮度显示:
要对文本块做评注,你只需要点击它旁边的标识块:
我们会仔细阅读每个评论,如果可能的话我们也会把评注考虑到未来的版本中去:
如果你愿意你的评注被采用,请确保留下你的全名 (注意不是昵称或简称)
Many, many thanks to Jack Slocum; the inspiration and much of the code for the comment system comes from Jack's blog, and this site couldn't have been built without his wonderful
YAHOO.extlibrary. Thanks also to Yahoo for YUI itself.