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

More visibility to the example reading a CSV file in small chunks #1650

Open
ppcano opened this issue Jul 12, 2024 · 2 comments
Open

More visibility to the example reading a CSV file in small chunks #1650

ppcano opened this issue Jul 12, 2024 · 2 comments

Comments

@ppcano
Copy link
Collaborator

ppcano commented Jul 12, 2024

Reading large files can lead to OOM errors, which is a common problem with open() (here a minor related PR) .

The example using the new Stream API provides a solution for this.

Wondering how we could better connect this example with other parts of the docs or additional tutorials.

@ppcano
Copy link
Collaborator Author

ppcano commented Jul 15, 2024

cc @heitortsergent and @joanlopez who wrote the file.read and ReadableStream example

@joanlopez
Copy link
Contributor

Yeah! I always thought that we have very good material within the "Examples" section, but unfortunately its visibility is not very good (imho). So, I guess we could explore things like:

  • (Now, and from time to time), do a pass over all the examples and find all the places they could be linked to. For instance, the "HTTP Authentication" example could be linked from the HTTP module docs.
  • Try to find another, better place for such kind of useful resources. Like we have "Recommended practices" specifically for the Browser section. Perhaps a "Troubleshooting" section, where one of the topics is memory management?

Beyond that, it would also be very good to have better discoverability through the Search functionality, but afaik that's under discussion right now.

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

No branches or pull requests

2 participants