Add StateValue @remarks#4374
Conversation
this fixes an error when generating API documentation which prevents an documentation index page from being created
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 53ee34e:
|
| /** | ||
| * The string or object representing the state value relative to the parent state node. | ||
| * | ||
| * @remarks |
There was a problem hiding this comment.
can this whole JSDoc be rewritten somehow? @remarks seems to be somewhat non-standard so, for example, the IDE doesn't really understand it and displays @remarks verbatim
There was a problem hiding this comment.
For context, this is related to a PR I’m working on to generate XState API docs for the Stately site using API Extractor.
API Extractor expects TSDoc, and I realize now that @remarks happens to be something only TSDoc has:
There was a problem hiding this comment.
Yeah, so I think that perhaps there is something here that specifically breaks the API generation, like this markdown list (but maybe that's not it). So perhaps by rewriting this, by avoiding the problematic pattern - we wouldn't have to introduce non-standard @remarks
There was a problem hiding this comment.
Yes, it should be possible to re-write this comment to be JSDoc compatible, and still ensure the Markdown generated by API Extractor can be rendered without error by Docusaurus. I’ll take a look.
Also this will make more sense once I have the API docs PR up for review.
|
I'm closing this one as superseded by #4391 |
2 participants
this fixes an error when generating API documentation which prevents an documentation index page from being created