Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure and expand documentation #257

Merged
merged 4 commits into from
Mar 11, 2022
Merged

Conversation

adamreeve
Copy link
Contributor

This simplifies the examples in the readme and creates more detailed documentation on file reading and writing in separate files.

@adamreeve adamreeve requested a review from philjdf February 28, 2022 20:28
at the expense of memory, speed and flexibility.
It lets one write a whole row in a single call, often resulting in more readable code.

For example, writing a file with the row-oriented API and using a tuple to represent a row of values:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be worth saying something about the drawbacks?

philjdf
philjdf previously approved these changes Mar 4, 2022
Copy link
Member

@jgiannuzzi jgiannuzzi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is so much better, thanks @adamreeve!

@adamreeve adamreeve merged commit ca3d372 into G-Research:master Mar 11, 2022
@adamreeve adamreeve deleted the docs branch March 11, 2022 20:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants