Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

API reference should contain only the public API #1086

Open
sequba opened this issue Oct 27, 2022 · 3 comments
Open

API reference should contain only the public API #1086

sequba opened this issue Oct 27, 2022 · 3 comments
Labels
Docs Improvements or additions to documentation Impact: Medium

Comments

@sequba
Copy link
Contributor

sequba commented Oct 27, 2022 •
edited
Loading

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
@sequba sequba added the Docs Improvements or additions to documentation label Oct 27, 2022
@sequba sequba self-assigned this Oct 27, 2022
@sequba sequba mentioned this issue Dec 13, 2022
Merged
29 tasks
@sequba
Copy link
Contributor Author

sequba commented Dec 13, 2022

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

@sequba sequba mentioned this issue Jan 13, 2023
Open
@sequba
Copy link
Contributor Author

sequba commented Jan 13, 2023 •
edited
Loading

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

@sequba sequba removed their assignment Apr 13, 2023
@sequba
Copy link
Contributor Author

sequba commented Sep 14, 2023 •
edited
Loading

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs Improvements or additions to documentation Impact: Medium
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@sequba