fix(@lucide/svelte): proper doc comments for svelte components#4267
Open
blt-r wants to merge 1 commit intolucide-icons:mainfrom
Open
fix(@lucide/svelte): proper doc comments for svelte components#4267blt-r wants to merge 1 commit intolucide-icons:mainfrom
blt-r wants to merge 1 commit intolucide-icons:mainfrom
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.
The doc comments for the icon components like
<AirVent />are broken. The actual doc comment with information about the icon and preview is not present, instead there's just license in doc comment.The reason why the real doc comment wasn't present is because of incorrect syntax. In this PR I swapped it for proper svelte html-style doc comment.
The reason why the license was present in the doc comment is because it was inserted into the reexporting file and jsdoc parser applied it to the
export { default } from "./air-vent.svelte";item. To fix that I added jsdoc@filedeclaration to the license doc comment so that it applied to the file itself.In
appendBlockComments.mtsthere was also some old code leftover from Svelte 4 trying to add jsdoc comment to the component declaration. It did'n work and wasn't needed so I removed it.Before/after:
P.S.
It seemed very wasteful to include entire text of the license in every single file in the
./dist. I checked, and other packages (react, preact, vue, solid) just have:Should I change the svelte package to do the same?
Before Submitting