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

Coding Agent · Coding Agent · commit d26ad457d5da · 2025-10-11T21:36:23.000Z
diff --git a/README-es.md b/README-es.md
@@ -0,0 +1,78 @@
+Este 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 estructuradas 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 = """
+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
+```
+
+### Análisis de docstrings
+
+Analiza una 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 una docstring analizada 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. Google Docstring ha sido modificado para acomodar Notes, Examples
+3. A veces GoogleDoc string no tiene la indentación adecuada, especialmente cuando se genera desde LLMs como GPT o Mistral. PyDocSmith puede arreglar esas malas docstrings.
+4. Casos de prueba adicionales fueron añadidos para acomodar diferentes estilos de GoogleDocstring
+
+He actualizado esto basado en el caso de uso para - https://www.penify.dev
+
+## Contribución
+
+¡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,78 @@
+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.
+
+## Fonctionnalités
+
+- **Détection du style de docstring :** Détectez automatiquement le style des docstrings (par exemple, reST, Google, NumPydoc, Epydoc) en utilisant des heuristiques simples.
+- **Analyse des docstrings :** Convertissez les docstrings en représentations structurées, facilitant l'analyse et la manipulation de la documentation.
+- **Composition des docstrings :** Rendez les docstrings structurées en texte, permettant la génération et la modification automatisées des docstrings.
+- **Docstrings d'attributs :** Analysez 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
+```
+
+## Utilisation
+
+### Détection du style de docstring
+
+Détectez 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
+
+Analysez une docstring en ses composants :
+
+```python
+from PyDocSmith import parse, DocstringStyle
+
+parsed_docstring = parse(docstring, style=DocstringStyle.AUTO)
+print(parsed_docstring)
+```
+
+### Composition des docstrings
+
+Rendez une docstring analysée en texte :
+
+```python
+from PyDocSmith import compose
+
+docstring_text = compose(parsed_docstring, style=DocstringStyle.REST)
+print(docstring_text)
+```
+
+## Fonctionnalités avancées
+
+- **Analyser depuis l'objet :** PyDocSmith peut analyser les docstrings directement depuis les 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 :** Personnalisez le rendu des docstrings avec des styles compacts ou détaillés, et spécifiez 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. Google Docstring a été modifié pour accueillir Notes, Examples
+3. Parfois, GoogleDoc string n'a pas la bonne indentation, 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 différents styles de GoogleDocstring
+
+J'ai mis à jour cela basé sur le cas d'utilisation 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 डेवलपर्स के लिए दस्तावेज़ीकरण प्रथाओं में लचीलापन प्रदान करता है।
+
+## विशेषताएँ
+
+- **डॉकस्ट्रिंग शैली का पता लगाना:** सरल ह्यूरिस्टिक्स का उपयोग करके डॉकस्ट्रिंग्स की शैली (जैसे, reST, Google, NumPydoc, Epydoc) को स्वचालित रूप से पता लगाएं।
+- **डॉकस्ट्रिंग पार्सिंग:** डॉकस्ट्रिंग्स को संरचित प्रतिनिधित्व में परिवर्तित करें, जिससे दस्तावेज़ीकरण का विश्लेषण और हेरफेर करना आसान हो जाए।
+- **डॉकस्ट्रिंग रचना:** संरचित डॉकस्ट्रिंग्स को वापस टेक्स्ट में रेंडर करें, जिससे स्वचालित डॉकस्ट्रिंग पीढ़ी और संशोधन की अनुमति मिले।
+- **विशेषता डॉकस्ट्रिंग्स:** कक्षा और मॉड्यूल स्तर पर परिभाषित विशेषता डॉकस्ट्रिंग्स को पार्स करें, कक्षा गुणों और मॉड्यूल-स्तरीय चरों के दस्तावेज़ीकरण को बढ़ाएं।
+
+## स्थापना
+
+```bash
+pip install PyDocSmith
+```
+
+## उपयोग
+
+### डॉकस्ट्रिंग शैली का पता लगाना
+
+दिए गए टेक्स्ट की डॉकस्ट्रिंग शैली का पता लगाएं:
+
+```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
+```
+
+### डॉकस्ट्रिंग्स पार्स करना
+
+एक डॉकस्ट्रिंग को उसके घटकों में पार्स करें:
+
+```python
+from PyDocSmith import parse, DocstringStyle
+
+parsed_docstring = parse(docstring, style=DocstringStyle.AUTO)
+print(parsed_docstring)
+```
+
+### डॉकस्ट्रिंग्स रचना करना
+
+एक पार्स किए गए डॉकस्ट्रिंग को वापस टेक्स्ट में रेंडर करें:
+
+```python
+from PyDocSmith import compose
+
+docstring_text = compose(parsed_docstring, style=DocstringStyle.REST)
+print(docstring_text)
+```
+
+## उन्नत विशेषताएँ
+
+- **ऑब्जेक्ट से पार्स करें:** PyDocSmith Python ऑब्जेक्ट्स से सीधे डॉकस्ट्रिंग्स पार्स कर सकता है, जिसमें कक्षाएं और मॉड्यूल शामिल हैं, विशेषता डॉकस्ट्रिंग्स को संरचित प्रतिनिधित्व में शामिल करते हुए।
+- **कस्टम रेंडरिंग शैलियाँ:** कॉम्पैक्ट या विस्तृत शैलियों के साथ डॉकस्ट्रिंग्स के रेंडरिंग को कस्टमाइज़ करें, और उत्पन्न डॉकस्ट्रिंग टेक्स्ट के लिए कस्टम इंडेंटेशन निर्दिष्ट करें।
+
+## docstring_parser के संबंध में संशोधित चीजें
+
+1. डॉकस्ट्रिंग शैली का पता लगाने के लिए बेहतर ह्यूरिस्टिक्स
+2. Google डॉकस्ट्रिंग को नोट्स, उदाहरणों को समायोजित करने के लिए संशोधित किया गया है
+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 は、さまざまなスタイルのドックストリングを解析、検出、作成するために設計された多用途の Python パッケージです。reStructuredText (reST)、Google、NumPydoc、Epydoc などの複数のドックストリング規約をサポートし、Python 開発者のドキュメント実践に柔軟性を提供します。
+
+## 機能
+
+- **ドックストリングスタイルの検出：** シンプルなヒューリスティクスを使用してドックストリングのスタイル（例: reST、Google、NumPydoc、Epydoc）を自動的に検出します。
+- **ドックストリングの解析：** ドックストリングを構造化表現に変換し、ドキュメントの分析と操作を容易にします。
+- **ドックストリングの作成：** 構造化ドックストリングをテキストに戻してレンダリングし、自動ドックストリング生成と変更を可能にします。
+- **属性ドックストリング：** クラスおよびモジュールレベルで定義された属性ドックストリングを解析し、クラスプロパティとモジュールレベル変数のドキュメントを強化します。
+
+## インストール
+
+```bash
+pip install PyDocSmith
+```
+
+## 使用方法
+
+### ドックストリングスタイルの検出
+
+指定されたテキストのドックストリングスタイルを検出します：
+
+```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
+```
+
+### ドックストリングの解析
+
+ドックストリングをそのコンポーネントに解析します：
+
+```python
+from PyDocSmith import parse, DocstringStyle
+
+parsed_docstring = parse(docstring, style=DocstringStyle.AUTO)
+print(parsed_docstring)
+```
+
+### ドックストリングの作成
+
+解析されたドックストリングをテキストに戻してレンダリングします：
+
+```python
+from PyDocSmith import compose
+
+docstring_text = compose(parsed_docstring, style=DocstringStyle.REST)
+print(docstring_text)
+```
+
+## 高度な機能
+
+- **オブジェクトからの解析：** PyDocSmith は、クラスやモジュールを含む Python オブジェクトから直接ドックストリングを解析でき、属性ドックストリングを構造化表現に組み込みます。
+- **カスタムレンダリングスタイル：** コンパクトまたは詳細なスタイルでドックストリングのレンダリングをカスタマイズし、生成されたドックストリングテキストのカスタムインデントを指定します。
+
+## docstring_parser に関して変更されたもの
+
+1. ドックストリングスタイルを検出するためのより良いヒューリスティクス
+2. Google Docstring は Notes、Examples を収容するために変更されました
+3. 時々 GoogleDoc string は、特に GPT や Mistral などの LLMs から生成された場合、正しいインデントを持っていません。PyDocSmith はこれらの悪いドックストリングを修正できます。
+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
