Specify default values for all documented parameters
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 55/100
- Issue-Typ
- Dokumentation
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Aktiv
- Tech-Stack
- python
- Bereich
- documentation
Rechercherichtung
Start with the function docstrings in the cf-plot Python package, using the width=0.02 example from the issue as a model. Look for parameters that default to None and get their real value from an if not <kwarg> check in the function body, and note each actual default. Done when every documented parameter states its default value in its docstring, matching what the code does.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
There is currently mostly no indication of default values for the documented parameters in the function docstrings, and though in some cases this can be implied by the function signature (e.g. width=0.02), this isn't often a clue since in lots of cases the defaults are set after an if not <kwarg> check for None values. As per good (and indeed expected) docstring practice these should be added so the user knows what default value is used by the logic.
- Vorherrschende Sprache
- Python
- Sterne
- 21
- Forks
- 11
- Ø Merge
- 2 T. 2 Std.
- Gemergte PRs (30 T.)
- 10
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
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 NCAS-CMS/cf-plot
-
docs enhancement
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 77/100
Maintainer antworten meist innerhalb von 1 Tag
-
Add badges to READMEOffendocs
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 72/100
Maintainer antworten meist innerhalb von 1 Tag
-
enhancement
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
Maintainer antworten meist innerhalb von 1 Tag
-
dependencies infrastructure installation testing
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 78/100
Maintainer antworten meist innerhalb von 1 Tag
-
CI infrastructure testing
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 66/100
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in NCAS-CMS/cf-plot
Ähnliche Issues
-
`destroy` sans terminal répond « Aborted. » au lieu de réclamer `--yes` comme `clean` et `reset`Offenbug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
stephrobert/dsoxlab#354 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 77/100
jasonacox/pypowerwall#472 ·
Maintainer antworten meist innerhalb von 1 Tag
-
[Bug]: DoubleMLRDDData accepts a score_col that is no data column (as in its docstring example); the running variable then becomes a covariate and RDFlex failsEvtl. vergeben @vrjdev hat das heute übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
DoubleML/doubleml-for-py#455 ·
Maintainer antworten meist innerhalb von 1 Tag
-
[Bug]: Python mod.Box[T] annotation gets a false generic_arg edge that replaces the parameter_type one ('is' on tree-sitter nodes)Evtl. vergeben @rohit-jsfreaky hat das heute übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
Graphify-Labs/graphify#5110 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 2 Tagen
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
assafelovic/gpt-researcher#2277 ·
Maintainer antworten meist innerhalb von 10 Tagen