Last task was great. Can you add readme in hindi, ...

Coding Agent · Coding Agent · commit d7244b081bd4 · 2025-10-11T18:30:25.000Z
diff --git a/README.es.md b/README.es.md
@@ -0,0 +1,76 @@
+El proyecto es un fork del proyecto original - https://github.com/rr-/docstring_parser/
+
+# PyDocSmith
+
+PyDocSmith es un paquete Python versátil diseñado para analizar, detectar y componer docstrings en varios estilos. Soporta múltiples convenciones de docstrings, incluyendo reStructuredText (reST), Google, NumPydoc y Epydoc, proporcionando flexibilidad en las prácticas de documentación para desarrolladores de Python.
+
+## Features
+
+- **Docstring Style Detection:** Detectar automáticamente el estilo de los docstrings (por ejemplo, reST, Google, NumPydoc, Epydoc) usando heurísticas simples.
+- **Docstring Parsing:** Convertir docstrings en representaciones estructuradas, facilitando el análisis y manipulación de la documentación.
+- **Docstring Composition:** Renderizar docstrings estructuradas de vuelta a texto, permitiendo la generación y modificación automatizada de docstrings.
+- **Attribute Docstrings:** Analizar docstrings de atributos definidos a nivel de clase y módulo, mejorando la documentación de propiedades de clase y variables a nivel de módulo.
+
+## Installation
+
+```bash
+pip install PyDocSmith
+```
+
+## Usage
+
+### Detecting Docstring Style
+
+Detectar el estilo de docstring de un texto dado:
+
+```python
+from PyDocSmith import detect_docstring_style, DocstringStyle
+
+docstring = """
+This is an example docstring.
+:param param1: Description of param1
+:return: Description of return value
+"""
+style = detect_docstring_style(docstring)
+print(style)  # Outputs: DocstringStyle.EPYDOC
+```
+
+### Parsing Docstrings
+
+Analizar un docstring en sus componentes:
+
+```python
+from PyDocSmith import parse, DocstringStyle
+
+parsed_docstring = parse(docstring, style=DocstringStyle.AUTO)
+print(parsed_docstring)
+```
+
+### Composing Docstrings
+
+Renderizar un docstring analizado de vuelta a texto:
+
+```python
+from PyDocSmith import compose
+
+docstring_text = compose(parsed_docstring, style=DocstringStyle.REST)
+print(docstring_text)
+```
+
+## Advanced Features
+
+- **Parse From Object:** PyDocSmith puede analizar docstrings directamente desde objetos Python, incluyendo clases y módulos, incorporando docstrings de atributos en la representación estructurada.
+- **Custom Rendering Styles:** Personalizar el renderizado de docstrings con estilos compactos o detallados, y especificar indentación personalizada para el texto de docstring generado.
+
+## Things that have been modified wrt to docstring_parser
+
+1. Mejores heurísticas para detectar el estilo de docstring
+2. Google Docstring ha sido modificado para acomodar Notes, Examples
+3. A veces la cadena GoogleDoc no tiene indentación apropiada, especialmente cuando se genera desde LLMs como GPT o Mistral. PyDocSmith puede corregir esas malas docstrings.
+4. Casos de prueba adicionales fueron añadidos para acomodar un estilo diferente de GoogleDocstring
+
+He actualizado esto basado en el caso de uso para - https://www.penify.dev
+
+## Contributing
+
+¡Las contribuciones son bienvenidas! Por favor, envíe pull requests o reporte problemas en la página de GitHub del proyecto.
diff --git a/README.fr.md b/README.fr.md
@@ -0,0 +1,76 @@
+Ce projet est un fork du projet original - https://github.com/rr-/docstring_parser/
+
+# PyDocSmith
+
+PyDocSmith est un package Python polyvalent conçu pour analyser, détecter et composer des docstrings dans divers styles. Il prend en charge plusieurs conventions de docstrings, y compris reStructuredText (reST), Google, NumPydoc et Epydoc, offrant une flexibilité dans les pratiques de documentation pour les développeurs Python.
+
+## Features
+
+- **Docstring Style Detection:** Détecter automatiquement le style des docstrings (par exemple, reST, Google, NumPydoc, Epydoc) en utilisant des heuristiques simples.
+- **Docstring Parsing:** Convertir les docstrings en représentations structurées, facilitant l'analyse et la manipulation de la documentation.
+- **Docstring Composition:** Rendre les docstrings structurées en texte, permettant la génération et la modification automatisées des docstrings.
+- **Attribute Docstrings:** Analyser les docstrings d'attributs définis au niveau des classes et des modules, améliorant la documentation des propriétés de classe et des variables au niveau du module.
+
+## Installation
+
+```bash
+pip install PyDocSmith
+```
+
+## Usage
+
+### Detecting Docstring Style
+
+Détecter le style de docstring d'un texte donné:
+
+```python
+from PyDocSmith import detect_docstring_style, DocstringStyle
+
+docstring = """
+This is an example docstring.
+:param param1: Description of param1
+:return: Description of return value
+"""
+style = detect_docstring_style(docstring)
+print(style)  # Outputs: DocstringStyle.EPYDOC
+```
+
+### Parsing Docstrings
+
+Analyser une docstring en ses composants:
+
+```python
+from PyDocSmith import parse, DocstringStyle
+
+parsed_docstring = parse(docstring, style=DocstringStyle.AUTO)
+print(parsed_docstring)
+```
+
+### Composing Docstrings
+
+Rendre une docstring analysée en texte:
+
+```python
+from PyDocSmith import compose
+
+docstring_text = compose(parsed_docstring, style=DocstringStyle.REST)
+print(docstring_text)
+```
+
+## Advanced Features
+
+- **Parse From Object:** PyDocSmith peut analyser les docstrings directement à partir d'objets Python, y compris les classes et les modules, incorporant les docstrings d'attributs dans la représentation structurée.
+- **Custom Rendering Styles:** Personnaliser le rendu des docstrings avec des styles compacts ou détaillés, et spécifier une indentation personnalisée pour le texte de docstring généré.
+
+## Things that have been modified wrt to docstring_parser
+
+1. Meilleures heuristiques pour détecter le style de docstring
+2. Google Docstring a été modifié pour accueillir Notes, Examples
+3. Parfois, la chaîne GoogleDoc n'a pas une indentation appropriée, surtout lorsqu'elle est générée à partir de LLMs comme GPT ou Mistral. PyDocSmith peut corriger ces mauvaises docstrings.
+4. Des cas de test supplémentaires ont été ajoutés pour accueillir un style différent de GoogleDocstring
+
+J'ai mis à jour cela basé sur le cas d'utilisation pour - https://www.penify.dev
+
+## Contributing
+
+Les contributions sont les bienvenues ! Veuillez soumettre des pull requests ou signaler des problèmes sur la page GitHub du projet.
diff --git a/README.hi.md b/README.hi.md
@@ -0,0 +1,76 @@
+यह परियोजना मूल परियोजना से एक फोर्क है - https://github.com/rr-/docstring_parser/
+
+# PyDocSmith
+
+PyDocSmith एक बहुमुखी Python पैकेज है जिसे विभिन्न शैलियों में डॉकस्ट्रिंग को पार्स करने, पता लगाने और रचना करने के लिए डिज़ाइन किया गया है। यह reStructuredText (reST), Google, NumPydoc, और Epydoc सहित कई डॉकस्ट्रिंग सम्मेलनों का समर्थन करता है, जो Python डेवलपर्स के लिए दस्तावेज़ीकरण प्रथाओं में लचीलापन प्रदान करता है।
+
+## Features
+
+- **Docstring Style Detection:** सरल ह्यूरिस्टिक्स का उपयोग करके डॉकस्ट्रिंग की शैली (जैसे, reST, Google, NumPydoc, Epydoc) को स्वचालित रूप से पता लगाएं।
+- **Docstring Parsing:** डॉकस्ट्रिंग को संरचित प्रतिनिधित्व में परिवर्तित करें, जिससे दस्तावेज़ीकरण का विश्लेषण और हेरफेर करना आसान हो जाता है।
+- **Docstring Composition:** संरचित डॉकस्ट्रिंग को वापस टेक्स्ट में रेंडर करें, जिससे स्वचालित डॉकस्ट्रिंग पीढ़ी और संशोधन की अनुमति मिलती है।
+- **Attribute Docstrings:** क्लास और मॉड्यूल स्तर पर परिभाषित विशेषता डॉकस्ट्रिंग को पार्स करें, क्लास गुणों और मॉड्यूल-स्तरीय चर के दस्तावेज़ीकरण को बढ़ाते हुए।
+
+## Installation
+
+```bash
+pip install PyDocSmith
+```
+
+## Usage
+
+### Detecting Docstring Style
+
+किसी दिए गए टेक्स्ट की डॉकस्ट्रिंग शैली का पता लगाएं:
+
+```python
+from PyDocSmith import detect_docstring_style, DocstringStyle
+
+docstring = """
+This is an example docstring.
+:param param1: Description of param1
+:return: Description of return value
+"""
+style = detect_docstring_style(docstring)
+print(style)  # Outputs: DocstringStyle.EPYDOC
+```
+
+### Parsing Docstrings
+
+एक डॉकस्ट्रिंग को उसके घटकों में पार्स करें:
+
+```python
+from PyDocSmith import parse, DocstringStyle
+
+parsed_docstring = parse(docstring, style=DocstringStyle.AUTO)
+print(parsed_docstring)
+```
+
+### Composing Docstrings
+
+एक पार्स की गई डॉकस्ट्रिंग को वापस टेक्स्ट में रेंडर करें:
+
+```python
+from PyDocSmith import compose
+
+docstring_text = compose(parsed_docstring, style=DocstringStyle.REST)
+print(docstring_text)
+```
+
+## Advanced Features
+
+- **Parse From Object:** PyDocSmith Python ऑब्जेक्ट्स से सीधे डॉकस्ट्रिंग पार्स कर सकता है, जिसमें क्लासेस और मॉड्यूल्स शामिल हैं, विशेषता डॉकस्ट्रिंग को संरचित प्रतिनिधित्व में शामिल करते हुए।
+- **Custom Rendering Styles:** कॉम्पैक्ट या विस्तृत शैलियों के साथ डॉकस्ट्रिंग के रेंडरिंग को अनुकूलित करें, और उत्पन्न डॉकस्ट्रिंग टेक्स्ट के लिए कस्टम इंडेंटेशन निर्दिष्ट करें।
+
+## Things that have been modified wrt to docstring_parser
+
+1. डॉकस्ट्रिंग शैली का पता लगाने के लिए बेहतर ह्यूरिस्टिक्स
+2. Google Docstring को Notes, Examples को समायोजित करने के लिए संशोधित किया गया है
+3. कभी-कभी GoogleDoc स्ट्रिंग में उचित इंडेंटेशन नहीं होता है, विशेष रूप से जब इसे LLMs जैसे GPT या Mistral से उत्पन्न किया जाता है। PyDocSmith उन खराब डॉकस्ट्रिंग को ठीक कर सकता है।
+4. GoogleDocstring की एक अलग शैली को समायोजित करने के लिए अतिरिक्त टेस्ट-केस जोड़े गए
+
+मैंने इसे उपयोग के मामले के आधार पर अपडेट किया है - https://www.penify.dev
+
+## Contributing
+
+योगदान स्वागत योग्य हैं! कृपया परियोजना के GitHub पेज पर पुल रिक्वेस्ट सबमिट करें या मुद्दे रिपोर्ट करें।
diff --git a/README.ja.md b/README.ja.md
@@ -0,0 +1,76 @@
+このプロジェクトは元のプロジェクトのフォークです - https://github.com/rr-/docstring_parser/
+
+# PyDocSmith
+
+PyDocSmith は、さまざまなスタイルのドックストリングを解析、検出、作成するために設計された多用途の Python パッケージです。reStructuredText (reST)、Google、NumPydoc、Epydoc などの複数のドックストリング規約をサポートし、Python 開発者のドキュメント実践に柔軟性を提供します。
+
+## Features
+
+- **Docstring Style Detection:** シンプルなヒューリスティックを使用してドックストリングのスタイル（例: reST、Google、NumPydoc、Epydoc）を自動的に検出します。
+- **Docstring Parsing:** ドックストリングを構造化表現に変換し、ドキュメントの分析と操作を容易にします。
+- **Docstring Composition:** 構造化ドックストリングをテキストに戻してレンダリングし、自動ドックストリング生成と変更を可能にします。
+- **Attribute Docstrings:** クラスおよびモジュールレベルで定義された属性ドックストリングを解析し、クラスプロパティとモジュールレベル変数のドキュメントを強化します。
+
+## Installation
+
+```bash
+pip install PyDocSmith
+```
+
+## Usage
+
+### Detecting Docstring Style
+
+指定されたテキストのドックストリングスタイルを検出します：
+
+```python
+from PyDocSmith import detect_docstring_style, DocstringStyle
+
+docstring = """
+This is an example docstring.
+:param param1: Description of param1
+:return: Description of return value
+"""
+style = detect_docstring_style(docstring)
+print(style)  # Outputs: DocstringStyle.EPYDOC
+```
+
+### Parsing Docstrings
+
+ドックストリングをそのコンポーネントに解析します：
+
+```python
+from PyDocSmith import parse, DocstringStyle
+
+parsed_docstring = parse(docstring, style=DocstringStyle.AUTO)
+print(parsed_docstring)
+```
+
+### Composing Docstrings
+
+解析されたドックストリングをテキストに戻してレンダリングします：
+
+```python
+from PyDocSmith import compose
+
+docstring_text = compose(parsed_docstring, style=DocstringStyle.REST)
+print(docstring_text)
+```
+
+## Advanced Features
+
+- **Parse From Object:** PyDocSmith は、クラスやモジュールを含む Python オブジェクトから直接ドックストリングを解析でき、属性ドックストリングを構造化表現に組み込みます。
+- **Custom Rendering Styles:** コンパクトまたは詳細なスタイルでドックストリングのレンダリングをカスタマイズし、生成されたドックストリングテキストのカスタムインデントを指定します。
+
+## Things that have been modified wrt to docstring_parser
+
+1. ドックストリングスタイルを検出するためのより良いヒューリスティック
+2. Google Docstring は Notes、Examples を収容するために変更されました
+3. 時々 GoogleDoc 文字列は適切なインデントを持たず、特に GPT や Mistral などの LLMs から生成された場合。PyDocSmith はこれらの悪いドックストリングを修正できます。
+4. 異なるスタイルの GoogleDocstring を収容するために追加のテストケースが追加されました
+
+私はこれを - https://www.penify.dev のユースケースに基づいて更新しました
+
+## Contributing
+
+貢献は歓迎されます！プロジェクトの GitHub ページでプルリクエストを送信するか、問題を報告してください。
diff --git a/README.ru.md b/README.ru.md
diff --git a/README.zh.md b/README.zh.md
