docs: correct JSDoc and README examples - #13
Merged
Merged
Conversation
Fix JSDoc that contradicted the code (LocalsConventionFunction return, getJSON's side effect, generateScopedName, modules: false, PostCSSModuleLoader) and README examples that did not compile. The tailwindcss4 example output gains `.absolute` because Tailwind scans the plugin source and the new JSDoc uses the word. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
1 participant
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
Corrects JSDoc that contradicted the code and README examples that did not
compile. Comments and docs only.
Changes
LocalsConventionFunctionreturns the exported key, not the scoped name.getJSONdocumented as a callback; the plugin writes<file>.jsonbesidethe source unless one is supplied.
generateScopedName,pluginswithmodules: false, and thePostCSSModuleLoaderstub now describe what the code does.configPathin the Deno loader example, fix thepostcss.config.tsimport path, and use the default export of@tailwindcss/postcss.deno doc --lint: 7 → 0 findings.examples/tailwindcss4/out/main.cssgains.absolute: Tailwind scans theplugin source, and the new JSDoc uses the word "absolute".
Testing
deno task checkanddeno task testpass (7 passed) from a standalone copyof this tree.
Closes
Nothing.
🤖 Generated with Claude Code