Skip to content

Commit 44e9b3f

Browse files
author
Coding Agent
committed
https://github.com/Penify-dev/PyDocSmith.git
1 parent ae8916f commit 44e9b3f

7 files changed

Lines changed: 0 additions & 56 deletions

File tree

README.es.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,4 @@ print(docstring_text)
6464
- **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.
6565
- **Estilos de renderizado personalizados:** Personalizar el renderizado de docstrings con estilos compactos o detallados, y especificar indentación personalizada para el texto de docstring generado.
6666

67-
## Cosas que han sido modificadas con respecto a docstring_parser
68-
69-
1. Mejores heurísticas para detectar el estilo de docstring
70-
2. Google Docstring ha sido modificado para acomodar Notas, Ejemplos
71-
3. A veces GoogleDoc string no tiene la indentación correcta, especialmente cuando se genera desde LLMs como GPT o Mistral. PyDocSmith puede corregir esas malas docstrings.
72-
4. Casos de prueba adicionales fueron añadidos para acomodar un estilo diferente de GoogleDocstring
73-
74-
He actualizado esto basado en el caso de uso para - https://www.penify.dev
7567

README.fr.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,4 @@ print(docstring_text)
6464
- **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.
6565
- **Styles de rendu personnalisés :** 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é.
6666

67-
## Choses qui ont été modifiées par rapport à docstring_parser
68-
69-
1. Meilleures heuristiques pour détecter le style de docstring
70-
2. Google Docstring a été modifié pour accommoder Notes, Examples
71-
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.
72-
4. Des cas de test supplémentaires ont été ajoutés pour accommoder un style différent de GoogleDocstring
73-
74-
J'ai mis à jour cela basé sur le cas d'utilisation pour - https://www.penify.dev
7567

README.hi.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,4 @@ print(docstring_text)
6464
- **ऑब्जेक्ट से पार्स करें:** PyDocSmith Python ऑब्जेक्ट्स से सीधे डॉकस्ट्रिंग पार्स कर सकता है, जिसमें क्लासेस और मॉड्यूल्स शामिल हैं, एट्रिब्यूट डॉकस्ट्रिंग को संरचित प्रतिनिधित्व में शामिल करते हुए।
6565
- **कस्टम रेंडरिंग शैलियां:** कॉम्पैक्ट या डिटेल्ड शैलियों के साथ डॉकस्ट्रिंग के रेंडरिंग को कस्टमाइज़ करें, और जनरेट किए गए डॉकस्ट्रिंग टेक्स्ट के लिए कस्टम इंडेंटेशन निर्दिष्ट करें।
6666

67-
## docstring_parser के संबंध में संशोधित चीजें
68-
69-
1. डॉकस्ट्रिंग शैली का पता लगाने के लिए बेहतर ह्यूरिस्टिक्स
70-
2. Google डॉकस्ट्रिंग को नोट्स, उदाहरणों को समायोजित करने के लिए संशोधित किया गया है
71-
3. कभी-कभी GoogleDoc स्ट्रिंग में विशेष रूप से जब LLMs जैसे GPT या Mistral से जनरेट किया जाता है तो उचित इंडेंटेशन नहीं होता। PyDocSmith उन खराब डॉकस्ट्रिंग को ठीक कर सकता है।
72-
4. GoogleDocstring की एक अलग शैली को समायोजित करने के लिए अतिरिक्त टेस्ट-केस जोड़े गए
73-
74-
मैंने इसे उपयोग के मामले के आधार पर अपडेट किया है - https://www.penify.dev
7567

README.ja.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,4 @@ print(docstring_text)
6464
- **オブジェクトからの解析:** PyDocSmith は、クラスやモジュールを含む Python オブジェクトから直接ドックストリングを解析でき、属性ドックストリングを構造化表現に組み込みます。
6565
- **カスタムレンダリングスタイル:** コンパクトまたは詳細なスタイルでドックストリングのレンダリングをカスタマイズし、生成されたドックストリングテキストのカスタムインデントを指定します。
6666

67-
## docstring_parser に関連して変更されたもの
68-
69-
1. ドックストリングスタイルの検出のためのより良いヒューリスティクス
70-
2. Google Docstring は Notes、Examples を収容するために変更されました
71-
3. 時々 GoogleDoc string は、特に GPT や Mistral などの LLMs から生成された場合、正しいインデントを持っていません。PyDocSmith はこれらの悪いドックストリングを修正できます。
72-
4. 異なるスタイルの GoogleDocstring を収容するために追加のテストケースが追加されました
73-
74-
私はこれを - https://www.penify.dev の使用ケースに基づいて更新しました
7567

README.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,5 @@ print(docstring_text)
6464
- **Parse From Object:** PyDocSmith can parse docstrings directly from Python objects, including classes and modules, incorporating attribute docstrings into the structured representation.
6565
- **Custom Rendering Styles:** Customize the rendering of docstrings with compact or detailed styles, and specify custom indentation for the generated docstring text.
6666

67-
## Things that have been modified wrt to docstring_parser
68-
69-
1. Better heuristics to detect docstring style
70-
2. Google Docstring has been modified to accommodate Notes, Examples
71-
3. Sometime GoogleDoc string doesn't have proper indentation specially when generated from LLMs like GPT or Mistral. PyDocSmith can fix those bad docstrings.
72-
4. Additional test-cases were added to accommodate a different style of GoogleDocstring
73-
74-
I have updated it based on use case for - https://www.penify.dev
7567

7668

README.ru.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,4 @@ print(docstring_text)
6464
- **Анализ из объекта:** PyDocSmith может анализировать докстринги непосредственно из объектов Python, включая классы и модули, включая докстринги атрибутов в структурированное представление.
6565
- **Пользовательские стили рендеринга:** Настраивать рендеринг докстрингов с компактными или детализированными стилями и указывать пользовательский отступ для генерируемого текста докстринга.
6666

67-
## Вещи, которые были изменены по сравнению с docstring_parser
68-
69-
1. Лучшие эвристики для обнаружения стиля докстринга
70-
2. Google Docstring был изменен для размещения Notes, Examples
71-
3. Иногда GoogleDoc string не имеет правильного отступа, особенно когда генерируется из LLMs вроде GPT или Mistral. PyDocSmith может исправить эти плохие докстринги.
72-
4. Дополнительные тестовые случаи были добавлены для размещения другого стиля GoogleDocstring
73-
74-
Я обновил это на основе случая использования для - https://www.penify.dev
7567

README.zh.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,4 @@ print(docstring_text)
6464
- **从对象解析:** PyDocSmith 可以直接从 Python 对象解析文档字符串,包括类和模块,将属性文档字符串纳入结构化表示。
6565
- **自定义渲染风格:** 使用紧凑或详细风格自定义文档字符串的渲染,并为生成的文档字符串文本指定自定义缩进。
6666

67-
## 与 docstring_parser 相比修改的事项
68-
69-
1. 更好的启发式来检测文档字符串风格
70-
2. Google Docstring 已修改以适应 Notes、Examples
71-
3. 有时 GoogleDoc string 没有正确的缩进,特别是当从 LLMs 如 GPT 或 Mistral 生成时。PyDocSmith 可以修复这些坏的文档字符串。
72-
4. 添加了额外的测试案例以适应不同的 GoogleDocstring 风格
73-
74-
我基于使用案例更新了这个 - https://www.penify.dev
7567

0 commit comments

Comments
 (0)