To state the obvious, it would be great to have some community maintained documentation (beyond generated API docs) for the Rust library. Writing documentation almost always causes the quality of a code base to improve because the process brings up rough edges, inconsistencies, or missing features.
On Sun, Jan 31, 2021 at 11:47 AM Benjamin Blodgett < benjaminblodg...@gmail.com> wrote: > This is great, thanks for this! > > On Sun, Jan 31, 2021 at 9:25 AM Fernando Herrera < > fernando.j.herr...@gmail.com> wrote: > > > Hi all, > > > > During the past months I have been trying to read and understand the code > > base for the Rust implementation of Arrow. At the beginning I was just > > reading the code and figuring out what each part or module was used for. > > Unfortunately this approach didn't work very well and had to start from > > scratch. The next time while trying to understand it I was also writing > > descriptions of the things I was studying and how to implement them. This > > approach led me to writing up a small Arrow guide. > > > > At this point is not complete and has several chapters missing, but > that's > > the point of this mail. I was wondering if someone that wants to work (or > > is already working) on the Rust side would like to help me make the guide > > better and richer. > > > > The first sections can be found here: > > https://elferherrera.github.io/arrow_guide/introduction.html > > > > And the repo is here: > > https://github.com/elferherrera/arrow_guide/ > > > > The guide at the moment is written with mdbook and uses the doc-comment > > crate to check all the code. Also, the book is pulling the Arrow crate > from > > git directly, so it is always reading the most recent api. > > > > I hope someone finds these writings useful and if you are willing to help > > me just let me know. > > > > Thanks, > > Fernando > > >
