handsontable / handsontable/hyperformula

Docs: add SimpleCellRange examples

Open
#772 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Docs Verified
Dominant language
TypeScript
Stars
2.8k
Forks
171
Avg merge
1d 22h
Merged PRs (30d)
7

Description

Description

In the HyperFormula API reference, certain methods take either SimpleCellAddress or SimpleCellRange as input, but the examples show only SimpleCellAddress input scenarios. We should add examples showing SimpleCellRange input as well:

getCellPrecedents
getCellDependents
isItPossibleToSetCellContents

The issue comes from this and this comment.

Links

https://handsontable.github.io/hyperformula/api/classes/hyperformula.html

Type of issue
  • Missing documentation
  • Error in the documentation
  • Request for a demo
  • Request for a tutorial, guide etc.
  • Other issues, suggestions or ideas

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the HyperFormula API reference linked in the issue and review the examples for getCellPrecedents, getCellDependents, and isItPossibleToSetCellContents. Add examples covering SimpleCellRange inputs alongside the existing SimpleCellAddress cases, then verify that all three API entries show both input scenarios.

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
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.