nushell / nushell/nushell.github.io

Can we add hyperlink to the data types?

Offen
#1,023 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
TypeScript
Sterne
258
Forks
561
Ø Merge
3 Std. 20 Min.
Gemergte PRs (30 T.)
15

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der Dokumentation des sleep-Befehls auf der verlinkten Seite und ermittle, wie seine Parametertypen dargestellt werden. Prüfe die Datentypdefinitionen und vorhandenen Dokumentationslinks, verlinke dann Datentypnamen konsistent und überprüfe, dass die sleep-Beispiele und die generierten Befehlsseiten die vorgesehenen Ziele anzeigen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.