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

Copy stream documentation looks confusing. Is it possible to update the documentation? #194

Open
chjose opened this issue Feb 14, 2016 · 1 comment · May be fixed by #260
Open

Copy stream documentation looks confusing. Is it possible to update the documentation? #194

chjose opened this issue Feb 14, 2016 · 1 comment · May be fixed by #260

Comments

@chjose
Copy link

chjose commented Feb 14, 2016

In the reading and writing file streams section only the copystream function is provided in the example. When i tried to copy a file to another there was error when the file was not properly opened with a filestream. I didn't really knew this.

http://madalgo.au.dk/tpie/doc/master/file_stream.html

I believe for beginners like me it would be great if we have a main function and also the required supporting functions in the documentation. Here is link to the code which helped me to solve the issue. May be it would be worth adding the tpie_init() section and also memory manager set limit part in this sections.

https://gist.github.com/adanner/238ce9ecb7ed7cfb072a

@Mortal
Copy link
Collaborator

Mortal commented Feb 14, 2016

Probably the introductory parts of the documentation should be more clear that we take the "clean close" flag very seriously. It also confused me when I was getting started with TPIE.

Basically, during development with TPIE, you should be prepared to delete your stream files yourself whenever your program crashes -- it can be annoying, but it is a sane default for a production build.

We could probably add Andrew's example program as a subsection of the file_stream.dox page. Feel free to submit a PR for it.

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 a pull request may close this issue.

2 participants