google-docstring-assistant

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Chinese

Write docstrings using the Google Python Style Guide structure (Args, Returns, Raises, Examples, Attributes, etc.).
Keep sections as headers followed by indented blocks; break sections by resuming unindented text.
When types are annotated in code, omit them in docstrings unless clarity is improved.
Use
```
Examples
```
blocks with literal blocks (
```
::
```
) for commands or code snippets.
Document module-level variables consistently (all in
```
Attributes
```
or inline), and list TODOs in a
```
Todo
```
section.
See
```
references/google_docstring_rules.md
```
for full guidance and examples.

Choose sections
- Functions: include
```
Args
```
  ,
```
Returns
```
  , and
```
Raises
```
  as needed.
- Modules/classes: use
```
Attributes
```
  and
```
Todo
```
  when relevant; keep formatting consistent.
Write clearly
- One docstring per object; keep it concise and informative.
- Use indentation under each section header; separate sections by returning to unindented text.
- Prefer Google-style wording; avoid duplicating annotated types unless helpful.
Examples and scripts
- Use
```
Examples:
```
  with indented literal blocks for shell commands or code snippets.
- Include multi-line descriptions when needed; keep formatting readable.

选择章节
- 函数：根据需要包含
```
Args
```
  、
```
Returns
```
  和
```
Raises
```
  。
- 模块/类：相关时使用
```
Attributes
```
  和
```
Todo
```
  ；保持格式一致。
清晰撰写
- 每个对象对应一个文档字符串；保持简洁且信息丰富。
- 在每个章节标题下使用缩进；通过回到无缩进文本来分隔章节。
- 优先使用Google风格的表述；除非有帮助，否则避免重复已标注的类型。
示例与脚本
- 使用
```
Examples:
```
  搭配缩进的文字块来展示Shell命令或代码片段。
- 必要时使用多行描述；保持格式可读性。

```
references/google_docstring_rules.md
```
: full style description and examples.