docs(plugin-ts,axios,fetch): document the comments option - #174
Merged
Conversation
Adds the `comments` option to the three plugin option references, with its 'brief' default and the reasoning behind it: descriptions are where the bytes go on a large spec, so the default keeps the opening sentence and 'full' restores the previous output. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019QYdRKpk7zCy1XVbydevXf
|
4 tasks
Drops a clause semicolon from the axios and fetch entries, and rewrites the plugin-ts sentence that managed to say "description" twice about the OpenAPI description of the OpenAI API. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019QYdRKpk7zCy1XVbydevXf
Brief no longer caps every description at 120. A sentence is kept whole up to 150, and a cut that would leave a markdown link or code span half written backs off. The saving on the OpenAI spec is 197 KB rather than 199 KB. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019QYdRKpk7zCy1XVbydevXf
The default moved from brief to full so upgrading changes nothing about generated output. Reordered each entry to lead with full, relabeled the plugin-ts code group, and added the missing comments row to all three option tables. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019QYdRKpk7zCy1XVbydevXf
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
2 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.
🎯 Changes
Documents the new
commentsoption added in kubb-labs/plugins#747, across the three plugin option references that now carry it.commentscontrols how much of each OpenAPIdescriptionreaches the generated JSDoc:'full'(default) emits every description in full, so upgrading changes nothing about generated output'brief'keeps the opening sentence'none'emits no JSDoc, leaving the generated-by banner untouchedPages updated:
plugins/plugin-ts/reference/options.md— full entry with a::: code-groupshowing the same property rendered at all three levels, placed beside the other scalar options (syntaxType,optionalType,arrayType)plugins/plugin-axios/reference/options.mdandplugins/plugin-fetch/reference/options.md— prose entries matching those pages' existing styleAll three pages were missing a
commentsrow in their option table at the top, so this adds one.Each entry spells out how a long description is handled at
'brief': a sentence is kept whole up to 150 characters, and one that never finishes is cut at the last word before 120, backing off further rather than leaving a markdown link or code span half written.The plugin-ts page carries the reasoning for opting in: descriptions are a third of what Kubb writes on a large spec, so
'brief'trims ~197 KB and'none'~1 MB of a 2.76 MB output.✅ Checklist
🤖 Generated with Claude Code
https://claude.ai/code/session_019QYdRKpk7zCy1XVbydevXf
Generated by Claude Code