SymPy-Projekt
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- SymPy
- Technischer Redakteur:
- Lacktly
- Projektname:
- Konsistenz in docstrings
- Projektdauer:
- Standardlaufzeit (3 Monate)
Projektbeschreibung
Bei diesem Projekt würde ich versuchen, die docstrings von SymPy einheitlicher zu gestalten.
In Zusammenarbeit mit meinen Mentoren würde ich zuerst die gewünschte Formatierung für eine Docstring in der Codebasis ermitteln. Dann würde ich einen Leitfaden für die Formatierung der Dokumentation für alle Docstrings in der Codebasis erstellen. Zu meinen Aufgaben im Projekt gehört auch die Implementierung des neuen Leitfadens zur Aktualisierung vorhandener Docstrings sowie die Erfassung und Behebung anderer Inkonsistenzen wie Sprachgebrauch oder Begriffe. Meine Mentoren und ich haben gemeinsam redaktionelle Entscheidungen darüber getroffen, wie mit diesen zusätzlichen Inkonsistenzen umgegangen werden soll. Die daraus resultierenden stilistischen Präferenzen wurden auch in den Leitfaden aufgenommen.
Das Endziel des Projekts wäre ein Formatierungs- und Stilhandbuch für die Dokumentation, das sowohl von Entwicklern als auch von Mitwirkenden verwendet werden kann, um die Einheitlichkeit der docstrings von SymPy jetzt und in Zukunft aufrechtzuerhalten.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Benötigte Informationen nicht gefunden","missingTheInformationINeed","thumb-down"],["Zu umständlich/zu viele Schritte","tooComplicatedTooManySteps","thumb-down"],["Nicht mehr aktuell","outOfDate","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Problem mit Beispielen/Code","samplesCodeIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2025-07-25 (UTC)."],[],["The project aims to standardize SymPy's docstrings. The technical writer will collaborate with mentors to define a consistent docstring format and create a documentation guide. This guide will be used to update existing docstrings and address inconsistencies in language and terminology. Mentors and the writer will make editorial decisions about the language, and document them. The outcome is a comprehensive guide for maintaining consistency in SymPy's docstrings.\n"]]
