tsp - Add description for array body and path parameter if missing#1505
Merged
Conversation
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
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.
This pull request improves how parameter and array schema descriptions are generated in the TypeSpec PowerShell converter, leading to more informative and user-friendly documentation output. The main changes focus on enhancing the fallback logic for descriptions when explicit documentation is missing.
Improvements to description generation:
convertor.ts, the logic for creating a parameter description now falls back to the schema's description if explicit documentation is unavailable, ensuring that parameters always have a meaningful description.modelUtils.ts, array schema descriptions now use available documentation or, if missing, generate a description like "Array of [type name]", making array types clearer in generated docs.