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

BcolzMinuteBarWriter and BcolzDailyBarWriter have undocumented differences in semantics of write method #225

Open
phelps-sg opened this issue Oct 9, 2023 · 0 comments · May be fixed by #226

Comments

@phelps-sg
Copy link

The write() methods of BcolzDailyBarWriter and BcolzMinuteBarWriter have identical signatures but very different semantics. Specifically BcolzMinuteBarWriter.write() appends to the table, whereas BcolzDailyBarWriter.write() overwrites the table. This is currently undocumented.

Ideally the code would be refactored so that each class implements an abstract method in a common abstract base-class and the append/rewrite behavior is consistent across both, but obviously there might be backward-compatibility issues.

Failing that, it would be good to document whether the behavior appends or rewrites the table in the docstring for each method.

phelps-sg added a commit to phelps-sg/zipline-reloaded that referenced this issue Oct 9, 2023
phelps-sg added a commit to phelps-sg/zipline-reloaded that referenced this issue Dec 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant