Skip to content

Fix README API documentation links #271

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

Open
miachillgood wants to merge 1 commit into
base: master
Choose a base branch
from
+6 −4
Open

Fix README API documentation links #271

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,10 @@ Pivot Tables, File Trees, or anytime you need:
## Documentation

What follows functions as a quick-start guide, and will explain the basics of
the Virtual Data Models, Styling and Interaction APIs. Complete
[API docs](https://github.com/finos/regular-table/blob/master/api.md) and
documented
the Virtual Data Models, Styling and Interaction APIs. The public API is
documented inline in the TypeScript source for
[`<regular-table>`](src/ts/regular-table.ts) and the
[virtual data model types](src/ts/types.ts), and documented
[examples](https://github.com/finos/regular-table/tree/master/examples) are also
available.

Expand All @@ -87,7 +88,8 @@ available.
- [Pivots, Filters, Sorts, and Column Expressions with `perspective`](#pivots-filters-sorts-and-column-expressions-with-perspective)
- [Development](#development)

- [API Docs](https://github.com/finos/regular-table/blob/master/api.md)
- [API Reference](src/ts/regular-table.ts)
- [Data Model Types](src/ts/types.ts)

- Annotated Examples
- [2d_array.md](examples/2d_array/2d_array.js)
Expand Down