hyperformula icon indicating copy to clipboard operation
hyperformula copied to clipboard
verified publisher icon handsontable

API reference should contain only the public API

Open sequba opened this issue 3 years ago • 3 comments

Description

  • analyze our code and define what exactly is public and should be included in the API reference
  • make sure all the code in our public API is well documented
  • configure the tools that generate our documentation to include only the public API (check how it's configured in HOT, it might be helpful)

Links

  • #1483
  • https://handsoncode.slack.com/archives/C044LF2LF71/p1666078448176849 (internal discussion accessible by budnix krzysztofspilka and sequba)
  • https://handsoncode.slack.com/archives/C031GBX62SE/p1666338806014269 (internal discussion)

sequba avatar Oct 27 '22 17:10 sequba

Related comment: https://github.com/handsontable/hyperformula/pull/1108/files#r1047321188

sequba avatar Dec 13 '22 15:12 sequba

It would be nice also to describe formally what our public API is through the exports property in package.json: #1144

sequba avatar Jan 13 '23 10:01 sequba

Turns out some items available as a public API are not documented, e.g.:

  • EmptyValue,
  • AlwaysDense,
  • AlwaysSparse, ...

sequba avatar Sep 14 '23 13:09 sequba