Documentation: expose missing docstrings for csp objects

Point72 / csp

csp is a high performance reactive stream processing library, written in C++ and Python

https://github.com/Point72/csp/wiki

Apache License 2.0

221 stars 37 forks source link

Open melissawm opened 8 months ago

melissawm commented 8 months ago

For example, csp.ticked is mentioned but could benefit from having its docstring exposed. This is probably true for other objects as well.

We can use this issue to capture a list of objects that need to be documented better.

pavithraes commented 6 months ago

Noting a couple more:

CSVReader & CSVWriter adapters
csp.Outputs & csp.output
Several functions in https://github.com/Point72/csp/wiki/CSP-Node#anatomy-of-a-cspnode can be noted in the API Reference as well
ParquetOutputConfig

timkpaine commented 6 months ago

RE CSVReader/Writer, i think we should rewrite from scratch xref https://github.com/Point72/csp/issues/259