Can you add readme in hindi, russion, french, span...

Coding Agent · Coding Agent · commit c9bdb1ed0a4f · 2025-10-11T21:26:36.000Z
diff --git a/README.es.md b/README.es.md
@@ -0,0 +1,78 @@
+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.
+
+## Características
+
+- **Detección de Estilo de Docstring:** Detecta automáticamente el estilo de los docstrings (por ejemplo, reST, Google, NumPydoc, Epydoc) utilizando heurísticas simples.
+- **Análisis de Docstrings:** Convierte docstrings en representaciones estructuradas, facilitando el análisis y manipulación de la documentación.
+- **Composición de Docstrings:** Renderiza docstrings estructurados de vuelta a texto, permitiendo la generación y modificación automatizada de docstrings.
+- **Docstrings de Atributos:** Analiza 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.
+
+## Instalación
+
+```bash
+pip install PyDocSmith
+```
+
+## Uso
+
+### Detección de Estilo de Docstring
+
+Detecta el estilo de docstring de un texto dado:
+
+```python
+from PyDocSmith import detect_docstring_style, DocstringStyle
+
+docstring = """
+Este es un ejemplo de docstring.
+:param param1: Descripción de param1
+:return: Descripción del valor de retorno
+"""
+style = detect_docstring_style(docstring)
+print(style)  # Salidas: DocstringStyle.EPYDOC
+```
+
+### Análisis de Docstrings
+
+Analiza un docstring en sus componentes:
+
+```python
+from PyDocSmith import parse, DocstringStyle
+
+parsed_docstring = parse(docstring, style=DocstringStyle.AUTO)
+print(parsed_docstring)
+```
+
+### Composición de Docstrings
+
+Renderiza un docstring analizado de vuelta a texto:
+
+```python
+from PyDocSmith import compose
+
+docstring_text = compose(parsed_docstring, style=DocstringStyle.REST)
+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.
+- **Estilos de Renderizado Personalizados:** Personaliza el renderizado de docstrings con estilos compactos o detallados, y especifica indentación personalizada para el texto de docstring generado.
+
+## Cosas que han sido modificadas con respecto a docstring_parser
+
+1. Mejores heurísticas para detectar el estilo de docstring
+2. El Docstring de Google ha sido modificado para acomodar Notas, Ejemplos
+3. A veces el string de GoogleDoc no tiene una indentación adecuada especialmente cuando se genera desde LLMs como GPT o Mistral. PyDocSmith puede arreglar esos docstrings malos.
+4. Se agregaron casos de prueba adicionales para acomodar un estilo diferente de GoogleDocstring
+
+He actualizado basado en el caso de uso para - https://www.penify.dev
+
+## Contribuyendo
+
+¡Las contribuciones son bienvenidas! Por favor envía pull requests o reporta problemas en la página de GitHub del proyecto.
diff --git a/README.fr.md b/README.fr.md
@@ -0,0 +1,78 @@
+Le 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.
+
+## Fonctionnalités
+
+- **Détection du style de docstring :** Détecte automatiquement le style des docstrings (par exemple, reST, Google, NumPydoc, Epydoc) en utilisant des heuristiques simples.
+- **Analyse des docstrings :** Convertit les docstrings en représentations structurées, facilitant l'analyse et la manipulation de la documentation.
+- **Composition des docstrings :** Rend les docstrings structurées sous forme de texte, permettant la génération et la modification automatisées des docstrings.
+- **Docstrings d'attributs :** Analyse les docstrings d'attributs définis aux niveaux de classe et de module, améliorant la documentation des propriétés de classe et des variables au niveau du module.
+
+## Installation
+
+```bash
+pip install PyDocSmith
+```
+
+## Utilisation
+
+### Détection du style de docstring
+
+Détecte 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
+```
+
+### Analyse des docstrings
+
+Analyse une docstring en ses composants :
+
+```python
+from PyDocSmith import parse, DocstringStyle
+
+parsed_docstring = parse(docstring, style=DocstringStyle.AUTO)
+print(parsed_docstring)
+```
+
+### Composition des docstrings
+
+Rend une docstring analysée sous forme de texte :
+
+```python
+from PyDocSmith import compose
+
+docstring_text = compose(parsed_docstring, style=DocstringStyle.REST)
+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.
+- **Styles de rendu personnalisés :** Personnalise le rendu des docstrings avec des styles compacts ou détaillés, et spécifie une indentation personnalisée pour le texte de docstring généré.
+
+## Choses qui ont été modifiées par rapport à docstring_parser
+
+1. Meilleures heuristiques pour détecter le style de docstring
+2. Le docstring Google a été modifié pour accueillir les Notes, les Exemples
+3. Parfois, le docstring Google n'a pas une indentation correcte, surtout lorsqu'il est généré à 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 accommoder un style différent de GoogleDocstring
+
+Je l'ai mis à jour en fonction du cas d'usage pour - https://www.penify.dev
+
+## Contribution
+
+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,78 @@
+यह परियोजना मूल परियोजना से एक फोर्क है - https://github.com/rr-/docstring_parser/
+
+
+
+# PyDocSmith
+
+PyDocSmith एक बहुमुखी Python पैकेज है जो विभिन्न शैलियों में डॉकस्ट्रिंग्स को पार्स करने, पता लगाने और रचना करने के लिए डिज़ाइन किया गया है। यह reStructuredText (reST), Google, NumPydoc, और Epydoc सहित कई डॉकस्ट्रिंग सम्मेलनों का समर्थन करता है, जो Python डेवलपर्स के लिए दस्तावेजीकरण प्रथाओं में लचीलापन प्रदान करता है।
+
+## विशेषताएँ
+
+- **Docstring Style Detection:** सरल ह्यूरिस्टिक्स का उपयोग करके डॉकस्ट्रिंग्स की शैली (जैसे, reST, Google, NumPydoc, Epydoc) को स्वचालित रूप से पता लगाएं।
+- **Docstring Parsing:** डॉकस्ट्रिंग्स को संरचित प्रतिनिधित्व में परिवर्तित करें, जिससे दस्तावेजीकरण का विश्लेषण और हेरफेर करना आसान हो जाता है।
+- **Docstring Composition:** संरचित डॉकस्ट्रिंग्स को वापस टेक्स्ट में रेंडर करें, जिससे स्वचालित डॉकस्ट्रिंग जनरेशन और संशोधन की अनुमति मिलती है।
+- **Attribute Docstrings:** क्लास और मॉड्यूल स्तर पर परिभाषित एट्रिब्यूट डॉकस्ट्रिंग्स को पार्स करें, क्लास प्रॉपर्टीज और मॉड्यूल-स्तरीय वेरिएबल्स के दस्तावेजीकरण को बढ़ाते हुए।
+
+## इंस्टॉलेशन
+
+```bash
+pip install PyDocSmith
+```
+
+## उपयोग
+
+### 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)  # आउटपुट: 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)
+```
+
+## उन्नत विशेषताएँ
+
+- **Parse From Object:** PyDocSmith Python ऑब्जेक्ट्स से सीधे डॉकस्ट्रिंग्स को पार्स कर सकता है, जिसमें क्लासेस और मॉड्यूल्स शामिल हैं, संरचित प्रतिनिधित्व में एट्रिब्यूट डॉकस्ट्रिंग्स को शामिल करते हुए।
+- **Custom Rendering Styles:** कॉम्पैक्ट या डिटेल्ड शैलियों के साथ डॉकस्ट्रिंग्स के रेंडरिंग को कस्टमाइज़ करें, और जनरेटेड डॉकस्ट्रिंग टेक्स्ट के लिए कस्टम इंडेंटेशन निर्दिष्ट करें।
+
+## docstring_parser के संबंध में जो चीजें संशोधित की गई हैं
+
+1. डॉकस्ट्रिंग शैली का पता लगाने के लिए बेहतर ह्यूरिस्टिक्स
+2. Google Docstring को Notes, Examples को समायोजित करने के लिए संशोधित किया गया है
+3. कभी-कभी GoogleDoc स्ट्रिंग में विशेष रूप से जब LLMs जैसे GPT या Mistral से जनरेट किया जाता है तो उचित इंडेंटेशन नहीं होता। PyDocSmith उन खराब डॉकस्ट्रिंग्स को ठीक कर सकता है।
+4. GoogleDocstring की एक अलग शैली को समायोजित करने के लिए अतिरिक्त टेस्ट-केस जोड़े गए
+
+मैंने इसे उपयोग के मामले के आधार पर अपडेट किया है - https://www.penify.dev
+
+## योगदान
+
+योगदान स्वागत योग्य हैं! कृपया परियोजना के GitHub पेज पर पुल रिक्वेस्ट सबमिट करें या मुद्दे रिपोर्ट करें।
diff --git a/README.ja.md b/README.ja.md
@@ -0,0 +1,78 @@
+このプロジェクトは、元のプロジェクトのフォークです - https://github.com/rr-/docstring_parser/
+
+
+
+# PyDocSmith
+
+PyDocSmith は、さまざまなスタイルの docstring を解析、検出、作成するための多用途の Python パッケージです。reStructuredText (reST)、Google、NumPydoc、Epydoc などの複数の docstring 規約をサポートし、Python 開発者のドキュメント作成に柔軟性を提供します。
+
+## 機能
+
+- **Docstring スタイル検出:** シンプルなヒューリスティックを使用して、docstring のスタイル（例: reST、Google、NumPydoc、Epydoc）を自動的に検出します。
+- **Docstring 解析:** docstring を構造化された表現に変換し、ドキュメントの分析と操作を容易にします。
+- **Docstring 作成:** 構造化された docstring をテキストに戻してレンダリングし、自動化された docstring の生成と修正を可能にします。
+- **属性 Docstring:** クラスおよびモジュールレベルで定義された属性 docstring を解析し、クラスプロパティとモジュールレベル変数のドキュメントを強化します。
+
+## インストール
+
+```bash
+pip install PyDocSmith
+```
+
+## 使用法
+
+### Docstring スタイルの検出
+
+指定されたテキストの docstring スタイルを検出します：
+
+```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)  # 出力: DocstringStyle.EPYDOC
+```
+
+### Docstring の解析
+
+docstring をそのコンポーネントに解析します：
+
+```python
+from PyDocSmith import parse, DocstringStyle
+
+parsed_docstring = parse(docstring, style=DocstringStyle.AUTO)
+print(parsed_docstring)
+```
+
+### Docstring の作成
+
+解析された docstring をテキストに戻してレンダリングします：
+
+```python
+from PyDocSmith import compose
+
+docstring_text = compose(parsed_docstring, style=DocstringStyle.REST)
+print(docstring_text)
+```
+
+## 高度な機能
+
+- **オブジェクトからの解析:** PyDocSmith は、クラスやモジュールを含む Python オブジェクトから直接 docstring を解析し、属性 docstring を構造化された表現に組み込むことができます。
+- **カスタムレンダリングスタイル:** コンパクトまたは詳細なスタイルで docstring のレンダリングをカスタマイズし、生成された docstring テキストのカスタムインデントを指定できます。
+
+## docstring_parser に対して変更された点
+
+1. docstring スタイルを検出するためのより良いヒューリスティック
+2. Google Docstring が Notes、Examples を収容するように変更されました
+3. GoogleDoc string は、特に GPT や Mistral のような LLM から生成された場合、適切なインデントを持たないことがあります。PyDocSmith はそれらの不良 docstring を修正できます。
+4. GoogleDocstring の異なるスタイルに対応するために追加のテストケースが追加されました
+
+私は https://www.penify.dev のユースケースに基づいて更新しました
+
+## 貢献
+
+貢献は歓迎します！プロジェクトの GitHub ページでプルリクエストを送信するか、問題を報告してください。
diff --git a/README.ru.md b/README.ru.md
diff --git a/README.zh.md b/README.zh.md
