tldraw/packages
Lu Wilson d99c4a0e9c
Make some missing tsdocs appear on the docs site (#1706)
🚨 Note 🚨
This PR has changed! See my [newer
comment](https://github.com/tldraw/tldraw/pull/1706#issuecomment-1623451709)
for what the PR does now.
This description is kept here to show the original intention of the PR.

---

This PR fixes the tsdocs formatting of `TldrawEditorProps`, so that they
appears on the docs site.

We have docs already written, but they weren't appearing. There are
probably others like this too.


![image](https://github.com/tldraw/tldraw/assets/15892272/8d8940b3-983f-48b3-9804-7ac88116ca9d)

### Change Type

- [x] `documentation` — Changes to the documentation only[^2]

[^1]: publishes a `patch` release, for devDependencies use `internal`
[^2]: will not publish a new version

### Test Plan

1. Navigate to `/gen/editor/TldrawEditorProps`
2. Make sure that that the parameters are listed out with descriptions.

- [ ] Unit Tests
- [ ] End to end tests

### Release Notes

- Docs: Fixed some missing docs for the TldrawEditor component.
2023-07-07 11:50:47 +00:00
..
assets Update CHANGELOG.md [skip ci] 2023-07-04 14:21:37 +00:00
editor Make some missing tsdocs appear on the docs site (#1706) 2023-07-07 11:50:47 +00:00
file-format Update CHANGELOG.md [skip ci] 2023-07-04 14:21:37 +00:00
indices Update CHANGELOG.md [skip ci] 2023-07-04 14:21:37 +00:00
polyfills Update CHANGELOG.md [skip ci] 2023-07-04 14:21:37 +00:00
primitives Update CHANGELOG.md [skip ci] 2023-07-04 14:21:37 +00:00
state Update CHANGELOG.md [skip ci] 2023-07-04 14:21:37 +00:00
store Update CHANGELOG.md [skip ci] 2023-07-04 14:21:37 +00:00
tldraw Update CHANGELOG.md [skip ci] 2023-07-04 14:21:37 +00:00
tlschema Update CHANGELOG.md [skip ci] 2023-07-04 14:21:37 +00:00
ui Make some missing tsdocs appear on the docs site (#1706) 2023-07-07 11:50:47 +00:00
utils Update CHANGELOG.md [skip ci] 2023-07-04 14:21:37 +00:00
validate Update CHANGELOG.md [skip ci] 2023-07-04 14:21:37 +00:00