Move several examples from the docs to tests and then `literalinclude` them
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Anfängerfreundlichkeit
- 35/100
- Issue-Typ
- Dokumentation
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- python
- Bereich
- documentation, testing-qa
Rechercherichtung
Beginne mit den drei Beispielen in docs/pages/future.rst, docs/pages/contrib/hypothesis_plugins.rst und docs/pages/context.rst und sieh dir anschließend tests/test_docs an. Verschiebe die Beispiele in diesen Testbereich, ersetze sie durch literalinclude-Direktiven und Quell-Links und aktualisiere pyproject.toml oder docs/requirements.txt nur bei Bedarf. Führe flake8, mypy und pytest aus; fertig ist die Aufgabe, wenn die Beispiele eingebunden, verlinkt und funktionsfähig sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
We have several quite large examples that live in our docs:
- https://github.com/dry-python/returns/blob/master/docs/pages/future.rst#futureresult
Numberexample from: https://github.com/dry-python/returns/blob/master/docs/pages/contrib/hypothesis_plugins.rst#check_all_laws- https://github.com/dry-python/returns/blob/master/docs/pages/context.rst#requirescontextfutureresult-container
What needs to be done?
- We need to extract these examples from docs to
tests/test_docsfolder - Instead, we should add this:
.. literalinclude:: ../../tests/test_docs/test_${SOME_NEW_FILENAME}.py
:linenos:
- Provide a link to the source code on github somewhere near the example itself
- Possibly we would need to add some dev-dependencies to both
pyproject.tomlanddocs/requirements.txt - Make sure that it is checked by
flake8,mypy, andpytest. And that it actually works.
This way we would have nice, complex, but working examples! 📖
- Vorherrschende Sprache
- Python
- Sterne
- 4.4k
- Forks
- 154
- Ø Merge
- 2 Std. 13 Min.
- Gemergte PRs (30 T.)
- 20
Entwicklungsumgebung
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus dry-python/returns
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 48/100
dry-python/returns#2394 · 1 Reaktion ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 52/100
dry-python/returns#2365 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
dry-python/returns#2355 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
bug
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 45/100
dry-python/returns#2295 · 4 Kommentare · 1 Reaktion ·
Maintainer antworten meist innerhalb von 1 Tag
-
bug
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 45/100
dry-python/returns#2253 · 2 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in dry-python/returns
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 86/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-2 Tage Anfängerfreundlichkeit 70/100
-
FingerprintSplitter raises ZeroDivisionError when int(frac_train * len(dataset)) floors to zeroOffen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
Maintainer antworten meist innerhalb von 7 Tagen
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
lmstudio-ai/mlx-engine#376 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
pyiron/bagofholding#166 ·