complete public API documentation #1212
Conversation
|
OmarTawfik
force-pushed
the
typedoc-site
branch
2 times, most recently
from
3e89c36 to
30cffc8
Compare
Adds `typedoc` linter, and fixes all violations in the public API. See the config in `crates/solidity/outputs/npm/package/typedoc.mjs` for more info.
OmarTawfik
force-pushed
the
typedoc-site
branch
from
30cffc8 to
5455207
Compare
| @@ -11,7 +11,7 @@ interface cst { | |||
| stub3, | |||
| {%- else %} | |||
| {%- for variant in model.kinds.nonterminal_kinds %} | |||
| /// This kind represents a `{{ variant.id }}` node, with the following structure: | |||
| /// Represents a node with kind `{{ variant.id | pascal_case }}`, having the following structure: | |||
There was a problem hiding this comment.
I'm not sure how useful a lot of this documentation is, considering it's mostly just repeating the type and identifier again. Is it important to the user to know that the node kind should be represented in pascal_case?
There was a problem hiding this comment.
The query language will always use PascalCase for node kinds, regardless of the client language. That might not be as important for this enum specifically, but for others like EdgeLabel, it is important, since the query language uses snake_case and TypeScript/Rust use PascalCase.
There was a problem hiding this comment.
Do you think the NonterminalKind docs here are adding noise/harming readability?
Adds
typedoclinter, and fixes all violations in the public API.See the config in
crates/solidity/outputs/npm/package/typedoc.mjsfor more info.