Discussion: Column / Table as private / implementation detail?
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 211
- Forks
- 29
- Avg merge
- 17h 30m
- Merged PRs (30d)
- 1
Description
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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the Column, Table, and Series API documentation and the issue thread to determine whether users must access Column or Table directly and whether their argument conventions are intentionally different. Done requires a maintainer decision on the public API and option conventions, followed by the corresponding documentation or API changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- backend-api-design, documentation
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100