docs: remove unused rootDir from parse JSDoc #17655
Closed
+6
−1
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.
Before submitting the PR, please make sure you do the following
feat:,fix:,chore:, ordocs:.packages/svelte/src, add a changeset (npx changeset).Tests and linting
pnpm testand lint the project withpnpm lintDescription
This PR fixes a documentation inconsistency in the
parsefunction located inpackages/svelte/src/compiler/index.js.Problems Solved:
The
parsefunction's JSDoc included arootDirparameter, but this option was neither destructured nor used in the actual implementation. This could lead to confusion for developers expecting therootDiroption to have an effect.Changes:
rootDirfrom the JSDoc@paramdefinition for theparsefunction.filenamedocumentation which is marked for removal in Svelte 6.0.patch) for thesveltepackage.Verification:
pnpm buildto ensure the package compiles correctly.pnpm lintandpnpm checkto confirm that all quality checks and type validations pass.