docs: improve JSDoc comments and generated type descriptions#184
Merged
docs: improve JSDoc comments and generated type descriptions#184
Conversation
Add meaningful descriptions to execution, cache, plugin, and telemetry types that were previously missing or too vague in the public API surface. Signed-off-by: Pawel Kosiec <pawel.kosiec@databricks.com>
pkosiec
force-pushed
the
pkosiec/appkit-docs-improvements
branch
from
5ac9154 to
e1049e6
Compare
MarioCadenas
approved these changes
Mar 16, 2026
atilafassina
approved these changes
Mar 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
descriptionfields toresourceFieldEntryandresourceRequirementin the JSON Schema, fixing auto-generated JSDoc that was previously unhelpful boilerplateStreamConfig,RetryConfig,TelemetryConfig,PluginExecuteConfig,PluginExecutionSettings,StreamExecuteHandler,StreamExecutionSettings,CacheConfig,PluginData,ToPlugin,normalizeTelemetryOptionsResourceRequirementandPluginManifestin registry typesgenerate-schema-types.tstooling)