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

Coding Agent · Coding Agent · commit 6acdca7eceda · 2025-10-12T00:10:16.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 docstring, incluyendo reStructuredText (reST), Google, NumPydoc y Epydoc, proporcionando flexibilidad en las prácticas de documentación para desarrolladores Python.
+
+## Características
+
+- **Detección de estilo de docstring:** Detecta automáticamente el estilo de los docstrings (por ejemplo, reST, Google, NumPydoc, Epydoc) usando 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 en niveles 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)  # Muestra: 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. La docstring de Google ha sido modificada para acomodar Notas, Ejemplos
+3. A veces la docstring de Google no tiene una indentación adecuada, especialmente cuando se genera desde LLMs como GPT o Mistral. PyDocSmith puede corregir esas malas docstrings.
+4. Se agregaron casos de prueba adicionales para acomodar un estilo diferente de GoogleDocstring
+
+He actualizado esto basado en el caso de uso para - https://www.penify.dev
+
+## Contribuyendo
+
+¡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 @@
+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 docstring, 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 en 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 = """
+Ceci est un exemple de docstring.
+:param param1: Description de param1
+:return: Description de la valeur de retour
+"""
+style = detect_docstring_style(docstring)
+print(style)  # Affiche : 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 en 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. La docstring Google a été modifiée pour accueillir Notes, Exemples
+3. Parfois, la docstring Google n'a pas une indentation correcte, 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 accommoder un style différent 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 पैकेज है जो विभिन्न शैलियों में docstrings को पार्स करने, पता लगाने और बनाने के लिए डिज़ाइन किया गया है। यह reStructuredText (reST), Google, NumPydoc, और Epydoc सहित कई docstring सम्मेलनों का समर्थन करता है, जो Python डेवलपर्स के लिए दस्तावेज़ीकरण प्रथाओं में लचीलापन प्रदान करता है।
+
+## विशेषताएं
+
+- **Docstring शैली का पता लगाना:** सरल ह्यूरिस्टिक्स का उपयोग करके docstrings की शैली (जैसे, reST, Google, NumPydoc, Epydoc) को स्वचालित रूप से पता लगाएं।
+- **Docstrings का पार्स करना:** Docstrings को संरचित प्रतिनिधित्व में परिवर्तित करें, जिससे दस्तावेज़ीकरण का विश्लेषण और हेरफेर करना आसान हो जाता है।
+- **Docstrings का निर्माण:** संरचित docstrings को वापस टेक्स्ट में रेंडर करें, जिससे स्वचालित docstring निर्माण और संशोधन की अनुमति मिलती है।
+- **विशेषता Docstrings:** कक्षा और मॉड्यूल स्तर पर परिभाषित विशेषता docstrings को पार्स करें, कक्षा गुणों और मॉड्यूल-स्तरीय चरों के दस्तावेज़ीकरण को बढ़ाएं।
+
+## स्थापना
+
+```bash
+pip install PyDocSmith
+```
+
+## उपयोग
+
+### Docstring शैली का पता लगाना
+
+दिए गए टेक्स्ट की docstring शैली का पता लगाएं:
+
+```python
+from PyDocSmith import detect_docstring_style, DocstringStyle
+
+docstring = """
+यह एक उदाहरण docstring है।
+:param param1: param1 का विवरण
+:return: वापसी मूल्य का विवरण
+"""
+style = detect_docstring_style(docstring)
+print(style)  # आउटपुट: DocstringStyle.EPYDOC
+```
+
+### Docstrings का पार्स करना
+
+एक docstring को उसके घटकों में पार्स करें:
+
+```python
+from PyDocSmith import parse, DocstringStyle
+
+parsed_docstring = parse(docstring, style=DocstringStyle.AUTO)
+print(parsed_docstring)
+```
+
+### Docstrings का निर्माण
+
+एक पार्स किए गए docstring को वापस टेक्स्ट में रेंडर करें:
+
+```python
+from PyDocSmith import compose
+
+docstring_text = compose(parsed_docstring, style=DocstringStyle.REST)
+print(docstring_text)
+```
+
+## उन्नत विशेषताएं
+
+- **ऑब्जेक्ट से पार्स करें:** PyDocSmith Python ऑब्जेक्ट्स से सीधे docstrings को पार्स कर सकता है, जिसमें कक्षाएं और मॉड्यूल शामिल हैं, संरचित प्रतिनिधित्व में विशेषता docstrings को शामिल करते हुए।
+- **कस्टम रेंडरिंग शैलियाँ:** कॉम्पैक्ट या विस्तृत शैलियों के साथ docstrings का रेंडरिंग कस्टमाइज़ करें, और उत्पन्न docstring टेक्स्ट के लिए कस्टम इंडेंटेशन निर्दिष्ट करें।
+
+## docstring_parser के संबंध में जो चीजें संशोधित की गई हैं
+
+1. Docstring शैली का पता लगाने के लिए बेहतर ह्यूरिस्टिक्स
+2. Google Docstring को Notes, Examples को समायोजित करने के लिए संशोधित किया गया है
+3. कभी-कभी GoogleDoc string में उचित इंडेंटेशन नहीं होती है, खासकर जब LLMs जैसे GPT या Mistral से उत्पन्न होती है। PyDocSmith उन खराब docstrings को ठीक कर सकता है।
+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 は、さまざまなスタイルの docstrings を解析、検出、作成するために設計された多用途の Python パッケージです。reStructuredText (reST)、Google、NumPydoc、Epydoc などの複数の docstring 規約をサポートし、Python 開発者のドキュメント実践に柔軟性を提供します。
+
+## 機能
+
+- **Docstring スタイル検出：** シンプルなヒューリスティックを使用して docstrings のスタイル（例: reST、Google、NumPydoc、Epydoc）を自動的に検出します。
+- **Docstring 解析：** docstrings を構造化表現に変換し、ドキュメントの分析と操作を容易にします。
+- **Docstring 作成：** 構造化された docstrings をテキストに戻してレンダリングし、自動 docstring 生成と変更を可能にします。
+- **属性 Docstrings：** クラスおよびモジュールレベルで定義された属性 docstrings を解析し、クラスプロパティとモジュールレベル変数のドキュメントを強化します。
+
+## インストール
+
+```bash
+pip install PyDocSmith
+```
+
+## 使用方法
+
+### Docstring スタイルの検出
+
+指定されたテキストの docstring スタイルを検出します：
+
+```python
+from PyDocSmith import detect_docstring_style, DocstringStyle
+
+docstring = """
+これはサンプル docstring です。
+:param param1: param1 の説明
+:return: 戻り値の説明
+"""
+style = detect_docstring_style(docstring)
+print(style)  # 出力: DocstringStyle.EPYDOC
+```
+
+### Docstrings の解析
+
+docstring をそのコンポーネントに解析します：
+
+```python
+from PyDocSmith import parse, DocstringStyle
+
+parsed_docstring = parse(docstring, style=DocstringStyle.AUTO)
+print(parsed_docstring)
+```
+
+### Docstrings の作成
+
+解析された docstring をテキストに戻してレンダリングします：
+
+```python
+from PyDocSmith import compose
+
+docstring_text = compose(parsed_docstring, style=DocstringStyle.REST)
+print(docstring_text)
+```
+
+## 高度な機能
+
+- **オブジェクトからの解析：** PyDocSmith は、クラスやモジュールを含む Python オブジェクトから直接 docstrings を解析し、属性 docstrings を構造化表現に組み込むことができます。
+- **カスタムレンダリングスタイル：** コンパクトまたは詳細なスタイルで docstrings のレンダリングをカスタマイズし、生成された docstring テキストのカスタムインデントを指定します。
+
+## docstring_parser と比較して変更されたこと
+
+1. Docstring スタイル検出のためのより良いヒューリスティック
+2. Google Docstring は Notes、Examples を収容するために変更されました
+3. 時々 GoogleDoc string は適切なインデントを持たない、特に LLMs のような GPT や Mistral から生成された場合。PyDocSmith はこれらの悪い docstrings を修正できます。
+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
