Skip to content

[docs] be more specific about the definition of page endpoints #5198

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

Merged
merged 6 commits into from
Jun 21, 2022

Conversation

gtm-nayan
Copy link
Contributor

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. All changesets should be patch until SvelteKit 1.0

@changeset-bot
Copy link

changeset-bot bot commented Jun 12, 2022

⚠️ No Changeset found

Latest commit: 230f70a

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

@kristjanmar
Copy link

I think this is harder to understand than the current sentence and I'm not sure what it means. But I agree that the docs on page endpoints can be improved, especially with more info about how they are different from the load function.

@gtm-nayan
Copy link
Contributor Author

@kristjanmar how about now?

@kristjanmar
Copy link

Much better.

"The filename for a page endpoint must also include any named layouts or matchers in its page's name."

Maybe something like this would be optimal just to make it more clear that this is an IF:

"If the page name has named layouts or matchers, then the filename for the page endpoint also needs to include them."

@benmccann benmccann added the documentation Improvements or additions to documentation label Jun 15, 2022
@Rich-Harris
Copy link
Member

much better 👍

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.

4 participants