nushell / nushell/nushell.github.io
Generate documentation for `std` commands
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 258
- Forks
- 561
- Ø Merge
- 3 Std. 20 Min.
- Gemergte PRs (30 T.)
- 15
Beschreibung
The std module is only passingly mentioned in a placeholder page. Currently the only way to learn about it is introspection or reading https://github.com/nushell/nushell/blob/main/crates/nu-std/std/mod.nu (how I discovered it). The testing submodule is "deprecated" but that's a separate issue 👈🏼 Already moved to a crate. I don't have any reservation about alpha development stage since Nushell isn't 1.0 yet. Not opposed to a banner indicating it's less stable than other APIs.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der Platzhalterseite unter nushell.sh/book/standard_library.html und vergleiche sie mit crates/nu-std/std/mod.nu. Dokumentiere die verfügbaren std-Befehle, damit Neueinsteiger sie ohne Introspection oder das Lesen des Quellcodes kennenlernen können, und erwäge, darauf hinzuweisen, dass sich die APIs in einer Alpha-Entwicklungsphase befinden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100