nushell / nushell/nushell.github.io

Dataframe expression explanations sould be more prominent

Offen
#1,084 1 Kommentar 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

Currently I find the documentation around dataframes and dataframe expressions to be very unclear/difficult to navigate. Some examples:

  1. In the documentation commands tab, there is a section labeled expression. This is about dataframe expressions specifically, and lazy data frames at that from as far as I can tell. I expected this tab to be about nu expressions specifically. This also meant that I thought a lot of documentation around dataframes such as group-by was missing, while it's actually in the expression section.
  2. The difference between lazy and eager dataframes is exlained but the implications of this are mentioned only off hand. For example, the fact that you can only use dfr col in a lazy expression, but dfr as datetime can't be at all was extremely confusing to me.
  3. Having three seperate pages for dfrcommands (dataframe, dataframe or lazy dataframe and expression) makes it much harder to find things and is also bad for discoverability. I for example, just thought a bunch of standard things in dataframes were not implemented because of this.

These are the issues that come to mind, I hope this will be read as constructive, as that's how I mean it, not just to criticise. These were just a few issues that caused me a lot of confusion when trying to understand them. Thanks for all the hard work!

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 dem Tab „documentation commands“ und den drei dfr-Seiten: dataframe, dataframe or lazy dataframe und expression. Vergleiche, wie dataframe-Ausdrücke, das Verhalten von lazy gegenüber eager und Befehle wie group-by, dfr col und dfr as datetime dargestellt werden. Als erledigt gilt die Aufgabe, wenn die relevanten Inhalte leichter zu finden sind und diese Unterscheidungen klar erklärt werden.

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
Muss geklärt werden
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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