nushell / nushell/nushell.github.io
Dataframe expression explanations sould be more prominent
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 258
- Forks
- 561
- Avg merge
- 3h 20m
- Merged PRs (30d)
- 15
Description
Currently I find the documentation around dataframes and dataframe expressions to be very unclear/difficult to navigate. Some examples:
- In the documentation
commandstab, there is a section labeledexpression. 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 asgroup-bywas missing, while it's actually in theexpressionsection. - 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 colin a lazy expression, butdfr as datetimecan't be at all was extremely confusing to me. - 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!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the documentation commands tab and the three dfr pages: dataframe, dataframe or lazy dataframe, and expression. Compare how dataframe expressions, lazy versus eager behavior, and commands such as group-by, dfr col, and dfr as datetime are presented. Done means the relevant material is easier to find and these distinctions are explained clearly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100