https://github.com/Penify-dev/PyDocSmith.git

Author: Coding Agent

README-es.md

@@ -59,6 +59,63 @@ docstring_text = compose(parsed_docstring, style=DocstringStyle.REST)
 print(docstring_text)
 ```
 
+### Análisis de docstring de Google con Notas y Ejemplos
+
+Detecta el estilo de docstring de un texto dado que contiene Notas y Ejemplos:
+
+```python
+from PyDocSmith import parse, DocstringStyle
+
+docstring = """
+Esta función hace algo.
+
+Args:
+    param1 (str): Descripción de param1
+
+Returns:
+    str: Descripción del valor de retorno
+
+Notes:
+    Esta es una nota.
+
+Examples:
+    >>> func('hello')
+    'hello world'
+"""
+
+parsed = parse(docstring, style=DocstringStyle.GOOGLE)
+print(parsed)
+```
+
+### Análisis de docstrings desde un objeto
+
+Analiza docstrings desde objetos Python:
+
+```python
+from PyDocSmith import parse_from_object
+
+class MyClass:
+    """Esta es una docstring de clase."""
+
+    attr: str
+    """Esta es una docstring de atributo."""
+
+parsed = parse_from_object(MyClass)
+print(parsed)
+```
+
+### Composición de docstrings con indentación personalizada
+
+Renderiza una docstring analizada con indentación personalizada:
+
+```python
+from PyDocSmith import compose
+
+# Asumiendo que parsed_docstring está disponible
+docstring_text = compose(parsed_docstring, style=DocstringStyle.GOOGLE, indent='    ')
+print(docstring_text)
+```
+
 ## Características avanzadas
 
 - **Analizar desde objeto:** PyDocSmith puede analizar docstrings directamente desde objetos Python, incluyendo clases y módulos, incorporando docstrings de atributos en la representación estructurada.

README-fr.md

@@ -59,6 +59,63 @@ docstring_text = compose(parsed_docstring, style=DocstringStyle.REST)
 print(docstring_text)
 ```
 
+### Analyse d'une docstring Google avec Notes et Examples
+
+Détecte le style de docstring d'un texte donné contenant Notes et Examples :
+
+```python
+from PyDocSmith import parse, DocstringStyle
+
+docstring = """
+Cette fonction fait quelque chose.
+
+Args:
+    param1 (str): Description de param1
+
+Returns:
+    str: Description de la valeur de retour
+
+Notes:
+    Ceci est une note.
+
+Examples:
+    >>> func('hello')
+    'hello world'
+"""
+
+parsed = parse(docstring, style=DocstringStyle.GOOGLE)
+print(parsed)
+```
+
+### Analyse des docstrings à partir d'un objet
+
+Analyse les docstrings à partir d'objets Python :
+
+```python
+from PyDocSmith import parse_from_object
+
+class MyClass:
+    """Ceci est une docstring de classe."""
+
+    attr: str
+    """Ceci est une docstring d'attribut."""
+
+parsed = parse_from_object(MyClass)
+print(parsed)
+```
+
+### Composition des docstrings avec une indentation personnalisée
+
+Rend une docstring analysée avec une indentation personnalisée :
+
+```python
+from PyDocSmith import compose
+
+# En supposant que parsed_docstring est disponible
+docstring_text = compose(parsed_docstring, style=DocstringStyle.GOOGLE, indent='    ')
+print(docstring_text)
+```
+
 ## Fonctionnalités avancées
 
 - **Analyser à partir d'un objet :** PyDocSmith peut analyser les docstrings directement à partir d'objets Python, y compris les classes et les modules, en incorporant les docstrings d'attributs dans la représentation structurée.

README-hi.md

@@ -59,6 +59,63 @@ docstring_text = compose(parsed_docstring, style=DocstringStyle.REST)
 print(docstring_text)
 ```
 
+### Google Docstring के साथ Notes और Examples पार्स करना
+
+दिए गए टेक्स्ट की docstring शैली का पता लगाएं जिसमें Notes और Examples हैं:
+
+```python
+from PyDocSmith import parse, DocstringStyle
+
+docstring = """
+यह फ़ंक्शन कुछ करता है।
+
+Args:
+    param1 (str): param1 का विवरण
+
+Returns:
+    str: वापसी मूल्य का विवरण
+
+Notes:
+    यह एक नोट है।
+
+Examples:
+    >>> func('hello')
+    'hello world'
+"""
+
+parsed = parse(docstring, style=DocstringStyle.GOOGLE)
+print(parsed)
+```
+
+### ऑब्जेक्ट से Docstrings पार्स करना
+
+Python ऑब्जेक्ट से docstrings पार्स करें:
+
+```python
+from PyDocSmith import parse_from_object
+
+class MyClass:
+    """यह एक कक्षा docstring है।"""
+
+    attr: str
+    """यह एक विशेषता docstring है।"""
+
+parsed = parse_from_object(MyClass)
+print(parsed)
+```
+
+### कस्टम इंडेंटेशन के साथ Docstrings का निर्माण
+
+कस्टम इंडेंटेशन के साथ एक पार्स किए गए docstring को रेंडर करें:
+
+```python
+from PyDocSmith import compose
+
+# मान लें कि parsed_docstring उपलब्ध है
+docstring_text = compose(parsed_docstring, style=DocstringStyle.GOOGLE, indent='    ')
+print(docstring_text)
+```
+
 ## उन्नत विशेषताएं
 
 - **ऑब्जेक्ट से पार्स करें:** PyDocSmith Python ऑब्जेक्ट्स से सीधे docstrings को पार्स कर सकता है, जिसमें कक्षाएं और मॉड्यूल शामिल हैं, संरचित प्रतिनिधित्व में विशेषता docstrings को शामिल करते हुए।

README-ja.md

@@ -59,6 +59,63 @@ docstring_text = compose(parsed_docstring, style=DocstringStyle.REST)
 print(docstring_text)
 ```
 
+### Notes と Examples を含む Google Docstring の解析
+
+Notes と Examples を含む指定されたテキストの docstring スタイルを検出します：
+
+```python
+from PyDocSmith import parse, DocstringStyle
+
+docstring = """
+この関数は何かをします。
+
+Args:
+    param1 (str): param1 の説明
+
+Returns:
+    str: 戻り値の説明
+
+Notes:
+    これはノートです。
+
+Examples:
+    >>> func('hello')
+    'hello world'
+"""
+
+parsed = parse(docstring, style=DocstringStyle.GOOGLE)
+print(parsed)
+```
+
+### オブジェクトからの Docstrings の解析
+
+Python オブジェクトから docstrings を解析します：
+
+```python
+from PyDocSmith import parse_from_object
+
+class MyClass:
+    """これはクラス docstring です。"""
+
+    attr: str
+    """これは属性 docstring です。"""
+
+parsed = parse_from_object(MyClass)
+print(parsed)
+```
+
+### カスタムインデントを使用した Docstrings の作成
+
+カスタムインデントを使用して解析された docstring をレンダリングします：
+
+```python
+from PyDocSmith import compose
+
+# parsed_docstring が利用可能であると仮定
+docstring_text = compose(parsed_docstring, style=DocstringStyle.GOOGLE, indent='    ')
+print(docstring_text)
+```
+
 ## 高度な機能
 
 - **オブジェクトからの解析：** PyDocSmith は、クラスやモジュールを含む Python オブジェクトから直接 docstrings を解析し、属性 docstrings を構造化表現に組み込むことができます。

README-ru.md

@@ -59,6 +59,63 @@ docstring_text = compose(parsed_docstring, style=DocstringStyle.REST)
 print(docstring_text)
 ```
 
+### Анализ Google Docstring с Notes и Examples
+
+Обнаруживает стиль docstring данного текста, содержащего Notes и Examples:
+
+```python
+from PyDocSmith import parse, DocstringStyle
+
+docstring = """
+Эта функция делает что-то.
+
+Args:
+    param1 (str): Описание param1
+
+Returns:
+    str: Описание возвращаемого значения
+
+Notes:
+    Это заметка.
+
+Examples:
+    >>> func('hello')
+    'hello world'
+"""
+
+parsed = parse(docstring, style=DocstringStyle.GOOGLE)
+print(parsed)
+```
+
+### Анализ docstrings из объекта
+
+Анализирует docstrings из объектов Python:
+
+```python
+from PyDocSmith import parse_from_object
+
+class MyClass:
+    """Это docstring класса."""
+
+    attr: str
+    """Это docstring атрибута."""
+
+parsed = parse_from_object(MyClass)
+print(parsed)
+```
+
+### Составление docstrings с пользовательским отступом
+
+Рендерит проанализированный docstring с пользовательским отступом:
+
+```python
+from PyDocSmith import compose
+
+# Предполагая, что parsed_docstring доступен
+docstring_text = compose(parsed_docstring, style=DocstringStyle.GOOGLE, indent='    ')
+print(docstring_text)
+```
+
 ## Продвинутые особенности
 
 - **Анализ из объекта:** PyDocSmith может анализировать docstrings непосредственно из объектов Python, включая классы и модули, включая docstrings атрибутов в структурированное представление.

README-zh.md

@@ -59,6 +59,63 @@ docstring_text = compose(parsed_docstring, style=DocstringStyle.REST)
 print(docstring_text)
 ```
 
+### 解析带有 Notes 和 Examples 的 Google Docstring
+
+检测包含 Notes 和 Examples 的给定文本的 docstring 样式：
+
+```python
+from PyDocSmith import parse, DocstringStyle
+
+docstring = """
+这个函数做了一些事情。
+
+Args:
+    param1 (str): param1 的描述
+
+Returns:
+    str: 返回值的描述
+
+Notes:
+    这是一个注释。
+
+Examples:
+    >>> func('hello')
+    'hello world'
+"""
+
+parsed = parse(docstring, style=DocstringStyle.GOOGLE)
+print(parsed)
+```
+
+### 从对象解析 Docstrings
+
+从 Python 对象解析 docstrings：
+
+```python
+from PyDocSmith import parse_from_object
+
+class MyClass:
+    """这是一个类 docstring。"""
+
+    attr: str
+    """这是一个属性 docstring。"""
+
+parsed = parse_from_object(MyClass)
+print(parsed)
+```
+
+### 使用自定义缩进编写 Docstrings
+
+使用自定义缩进渲染解析的 docstring：
+
+```python
+from PyDocSmith import compose
+
+# 假设 parsed_docstring 可用
+docstring_text = compose(parsed_docstring, style=DocstringStyle.GOOGLE, indent='    ')
+print(docstring_text)
+```
+
 ## 高级功能
 
 - **从对象解析：** PyDocSmith 可以直接从 Python 对象解析 docstrings，包括类和模块，将属性 docstrings 纳入结构化表示。