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

Documentation #22

Open
vkvam opened this issue Jan 11, 2020 · 1 comment
Open

Documentation #22

vkvam opened this issue Jan 11, 2020 · 1 comment

Comments

@vkvam
Copy link
Owner

vkvam commented Jan 11, 2020

Explain intent and alternatives (input and output file types) of each generator and the difference between iter flush() and flush_iter().

Before documenting, ensure there is only on filetype. File and FileStream can be differentiated by wether an optional stream is present on a file or not.

FileMeta could be changed to FileData, and the stream could be one of these, for performance reasons set this as an instance variable as well as in the FileData map. File is turned into a pure container, and FileData can be accessed through get_item()

For each Generator specify acceptable FileData combinations.

@vkvam
Copy link
Owner Author

vkvam commented Jan 12, 2020

FileStream was removed, functionality moved to File.

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

1 participant