node icon indicating copy to clipboard operation
node copied to clipboard

Discussion: Column / Table as private / implementation detail?

Open bryevdv opened this issue 4 years ago • 1 comments

Are there any instances where users must interact directly with Column or Table? If not I would propose considering them implementation details and removing them from the documentation in order to reduce the API surface area users need to be exposed to.

Tangentially related: Most Series methods accept a "bag of options" while most Column methods accept a list of args, sometimes ending in optional args. Should there be a recommended convention here? Column methods could also accept "bags of options" if that makes things more consistent or safe.

cc @trxcllnt @AjayThorve @ajschmidt8

bryevdv avatar Mar 23 '21 19:03 bryevdv

Are there any instances where users must interact directly with Column or Table? If not I would propose considering them implementation details and removing them from the documentation in order to reduce the API surface area users need to be exposed to.

I'll defer to Paul or Ajay on this.

Tangentially related: Most Series methods accept a "bag of options" while most Column methods accept a list of args, sometimes ending in optional args. Should there be a recommended convention here? Column methods could also accept "bags of options" if that makes things more consistent or safe.

Consistency seems good, though I'm ultimately indifferent here as TypeScript is pretty good about letting us know what arguments can be passed.

ajschmidt8 avatar Mar 24 '21 13:03 ajschmidt8