csp icon indicating copy to clipboard operation
csp copied to clipboard

Documentation: expose missing docstrings for csp objects

Open melissawm opened this issue 1 year ago • 2 comments

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.

melissawm avatar Mar 04 '24 17:03 melissawm

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

pavithraes avatar May 29 '24 14:05 pavithraes

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

timkpaine avatar May 29 '24 16:05 timkpaine