docs: remove deprecated loadNuxt options
#24201
Merged
Conversation
This file contains 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
Update loadNuxt documentation to latest version. `config` option was removed. `cwd` option is standard.
|
|
✅ Live Preview ready!
|
DamianGlowala
requested changes
Nov 11, 2023
DamianGlowala
changed the title
loadNuxt() params
DamianGlowala
changed the title
loadNuxt() paramsloadNuxt params
danielroe
reviewed
Nov 22, 2023
docs/3.api/5.kit/2.programmatic.md
Outdated
| @@ -53,24 +53,20 @@ Loading conditions for Nuxt. `loadNuxt` uses [`c12`](https://github.com/unjs/c12 | |||
|
|
|||
| If set to `true`, Nuxt will be ready to use after the `loadNuxt` call. If set to `false`, you will need to call `nuxt.ready()` to make sure Nuxt is ready to use. | |||
|
|
|||
| - `rootDir` (optional) | |||
| - `cwd` (optional) | |||
There was a problem hiding this comment.
These two parameters are both documented in the link above (https://github.com/unjs/c12).
This is meant to be a list of additional options that are respected.
Instead, shall we just remove them?
danielroe
changed the title
loadNuxt paramsloadNuxt options
Merged
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.
🔗 Linked issue
#24197
❓ Type of change
📚 Description
Update loadNuxt documentation to latest version.
configoption was removed.cwdoption is standard.The docs are out of date for these options. I filed a bug, then found the fix. This updates the docs for the next guy.
📝 Checklist