Skip to content

docs: fix navigation type JSDoc formatting - #16128

Merged
teemingc merged 1 commit into
sveltejs:mainfrom
vamshikrishnaramasamy:docs/issue-15910-navigation-type-format
Jun 23, 2026
Merged

docs: fix navigation type JSDoc formatting#16128
teemingc merged 1 commit into
sveltejs:mainfrom
vamshikrishnaramasamy:docs/issue-15910-navigation-type-format

Conversation

@vamshikrishnaramasamy

Copy link
Copy Markdown
Contributor

Closes #15910.\n\nRemoves the repeated The type of navigation: prefix from each navigation type JSDoc item so editors don't merge the prose into every union member hover.\n\nChecks:\n- pnpm --dir packages/kit generate:types\n- pnpm --dir packages/kit lint

@changeset-bot

changeset-bot Bot commented Jun 22, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: c6ab39a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@Rich-Harris Rich-Harris added the documentation Improvements or additions to documentation label Jun 22, 2026
@teemingc
teemingc merged commit 296f2b5 into sveltejs:main Jun 23, 2026
22 of 24 checks passed
@Rich-Harris

Copy link
Copy Markdown
Member

This should have had a changeset since it affects the published package!

It also makes the docs look kinda goofy IMHO:

image

It would be better to put the descriptions on the interfaces themselves I think. Opened #16147

Rich-Harris added a commit that referenced this pull request Jun 23, 2026
@teemingc

Copy link
Copy Markdown
Member

This should have had a changeset since it affects the published package!
Whoops that's my bad.

It would be better to put the descriptions on the interfaces themselves I think. Opened #16147

Thanks! The docs look a lot better. For future context, a very minor thing that's lost from this is the description only showing the text from each type that's currently in the union. e.g., if the only possible type is popstate, it would only show the popstate description because it doesn't merge the descriptions from the types in the union.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix "type of navigation" formatting

3 participants