nushell / nushell/nushell.github.io
Generate documentation for `std` commands
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 258
- Fork
- 561
- Merge medio
- 3h 20m
- PR unite (30g)
- 15
Descrizione
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.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dalla pagina segnaposto all’indirizzo nushell.sh/book/standard_library.html e confrontala con crates/nu-std/std/mod.nu. Documenta i comandi std disponibili, in modo che chi è alle prime armi possa impararli senza introspection o senza leggere il codice sorgente, e valuta di indicare che le APIs si trovano in una fase di sviluppo alpha.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100