handsontable / handsontable/hyperformula
Lots of FunctionPlugin's functions needs documenting
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.8k
- Forks
- 171
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 7
Description
Description
evaluateAst, arraySizeForAst, listOfScalarValues, coerceScalarToNumberOrError, runFunctionWithReferenceArgument, metadata all need documenting.
These are protected methods available for custom functions for users to use so they should be documented. They are already used in the NumericAggregationPlugin heavily.
Links
https://handsontable.github.io/hyperformula/guide/custom-functions.html#custom-class-definition
Type of issue
- Missing documentation
Contributor guide
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 with the custom class definition section of the linked custom-functions guide and inspect how NumericAggregationPlugin uses evaluateAst, arraySizeForAst, listOfScalarValues, coerceScalarToNumberOrError, runFunctionWithReferenceArgument, and metadata. Document these protected methods for custom-function authors, and confirm that all six are covered in the relevant API or guide documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100