bluenote10 / NimData

DataFrame API written in Nim, enabling fast out-of-core data processing
MIT License
341 stars 22 forks source link

Edits to tighten up the documentation #67

Closed davidjamesknight closed 3 years ago

davidjamesknight commented 3 years ago

Hi, I've started editing the README to (hopefully) make everything clearer for less advanced users. I only edited the first third or so, up until the Filter example. If you like these changes, I'll finish editing the rest of the doc.

Main changes:

One thing I wasn't sure about is whether "field" and "column" can be used interchangeably, e.g. the procs in the schema example have names like strCol and we'd call these "columns" in Pandas but the docs refer to them as fields. If we can clear this up, I'll add a section that describes DataFrame structure/terminology so everything is consistent.

Hope this helps and thanks for making this library!

bluenote10 commented 3 years ago

Thanks, I like all the improvements, so merging this right away :wink: