Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Doing a pass at adding some more undocumented functions and eventually adding more type annotations, etc. For now, just focusing on straightforward documentation tasks (though please leave comments or commit to this branch if you have any edits!), but I also have a couple other things in mind that would be good to discuss:
Pattern<number>
orPattern<X>
etc), but would that be an acceptable replacement fornumber | Pattern
? I think so, but could be convinced if we really want to emphasize that primitive values are acceptable and will be automatically reified.@signature
tag in cases (such asstack
or especiallylayer
) where the two usages are distinct. This would require a new jsdoc extension, but I don't think it's very complicated.@param {function(Hap):boolean}
) versus the Typescript style (@param {(hap: Hap) => boolean}
)? I prefer Typescript but don't mind the Closure style either. Both work in VS Code's jsdoc parser and unfortunately neither is actually supported by the jsdoc library, so we'd need an extension in either case.@internal
tag that disables autocomplete and maybe also hides them from the reference until we can improve the reference UI?