nushell / nushell/nushell.github.io

Can we add hyperlink to the data types?

Aperta
#1,023 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
TypeScript
Stelle
258
Fork
561
Merge medio
3h 20m
PR unite (30g)
15

Descrizione

As an example, I am reading the doc for the sleep command right now.
aka. https://www.nushell.sh/commands/docs/sleep.html

The signature says :
> sleep (duration) ...rest
and parameters are:

  • duration: time to sleep
  • ...rest: additional time
    with example:
  1. > sleep 1sec
  2. > sleep 1sec 1sec 1sec

I tried to do sleep 1hour and that doesn't work, then I realize that 'duration' might be
some kind of datatypes of nu, so why not leave a hyperlink to the datatype in the docs?

I think this would improve the readability so much if we can link all datatypes to their definition.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dalla documentazione del comando sleep nella pagina collegata e identifica come vengono visualizzati i relativi tipi di parametro. Controlla le definizioni dei tipi di dati e i link alla documentazione esistenti, quindi collega i nomi dei tipi di dati in modo coerente e verifica che gli esempi di sleep e le pagine dei comandi generate mostrino le destinazioni previste.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.