Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update api-reference.mdx #8373

Merged
merged 3 commits into from
May 23, 2024
Merged

Update api-reference.mdx #8373

merged 3 commits into from
May 23, 2024

Conversation

hfournier
Copy link
Contributor

The description for Astro.redirect() makes no mention of the optional second parameter, so I added a "note" about it.

Description (required)

The description for Astro.redirect() makes no mention of the optional second parameter, so I propose adding a "note" that it accepts an optional HTTP Status Code (linked it to MDN), and that the default is 302.

Related issues & labels (optional)

  • Closes #
  • Suggested label:

The description for Astro.redirect() makes no mention of the optional second parameter, so I added a note about it.
Copy link

vercel bot commented May 22, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview May 23, 2024 2:29pm

@astrobot-houston
Copy link
Contributor

astrobot-houston commented May 22, 2024

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

Locale File Note
en reference/api-reference.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@sarah11918
Copy link
Member

Thanks for this @hfournier ! We should absolutely be showing this! I took a quick editing pass to work the content into the actual description, since we don't like to add essential content by tacking on notes. (Docs can start to look pretty wild if we overuse that pattern!)

Take a look at the version I have and see whether you'd suggest any changes!

@hfournier
Copy link
Contributor Author

Thanks for this @hfournier ! We should absolutely be showing this! I took a quick editing pass to work the content into the actual description, since we don't like to add essential content by tacking on notes. (Docs can start to look pretty wild if we overuse that pattern!)

Take a look at the version I have and see whether you'd suggest any changes!

That looks good to me... and thanks for the heads up on not overusing notes on future updates.

Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Great, thank you so much, let's do this!

@sarah11918 sarah11918 added improve documentation Enhance existing documentation (e.g. add an example, improve description) Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! labels May 23, 2024
@sarah11918 sarah11918 merged commit 5be0f30 into withastro:main May 23, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improve documentation Enhance existing documentation (e.g. add an example, improve description) Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants