Skip to content

fix(types): update Astro.redirect JSDoc comment#11546

Merged
ematipico merged 2 commits intowithastro:mainfrom
ArmandPhilippot:fix/astro-redirect-type-comment
Jul 24, 2024
Merged

fix(types): update Astro.redirect JSDoc comment#11546
ematipico merged 2 commits intowithastro:mainfrom
ArmandPhilippot:fix/astro-redirect-type-comment

Conversation

@ArmandPhilippot
Copy link
Copy Markdown
Member

Changes

Update the inline documentation (JSDoc comment) for Astro.redirect:

I haven't added a changeset since it is a small change. Should I?

Testing

No test. I only reworded a comment.

Docs

No doc needed since it does not change the behavior. However it could be a nice addition to clarify the difference between server and static with Astro.redirect (I can post a suggestion on astro/docs separately of this PR).

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Jul 24, 2024

🦋 Changeset detected

Latest commit: 6ed812d

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

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

@github-actions github-actions bot added pkg: astro Related to the core `astro` package (scope) pr: docs A PR that includes documentation for review labels Jul 24, 2024
Copy link
Copy Markdown
Member

@ematipico ematipico left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, could you create a changeset? We usually track docs fixes too

@ArmandPhilippot
Copy link
Copy Markdown
Member Author

@ematipico Changeset added!

@ematipico ematipico merged commit 7f26de9 into withastro:main Jul 24, 2024
@astrobot-houston astrobot-houston mentioned this pull request Jul 24, 2024
@ArmandPhilippot ArmandPhilippot deleted the fix/astro-redirect-type-comment branch July 24, 2024 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pkg: astro Related to the core `astro` package (scope) pr: docs A PR that includes documentation for review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Astro.redirect JSDoc comment is wrong

2 participants