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

Contradiction in the upcoming getStaticPaths docs #10894

Closed
balazsorban44 opened this issue Mar 9, 2020 · 2 comments · Fixed by #10893
Closed

Contradiction in the upcoming getStaticPaths docs #10894

balazsorban44 opened this issue Mar 9, 2020 · 2 comments · Fixed by #10893

Comments

@balazsorban44
Copy link
Member

balazsorban44 commented Mar 9, 2020

Bug report

Describe the bug

There is a mismatch in the documentation. Although, it is an obvious, easy fix, if someone blindly copy-pastes the wrong example code, they might have hard time finding out what they did wrong.

To Reproduce

Steps to reproduce the behavior, please provide code snippets or a repository:

The example below is right: https://github.com/zeit/next.js/blob/canary/docs/basic-features/data-fetching.md#the-paths-key-required

The example below is wrong: https://github.com/zeit/next.js/blob/canary/docs/basic-features/data-fetching.md#fallback-false

Expected behavior

The documentation should be consistent

Screenshots

image

image

System information

irrelevant

Additional context

I have created a PR, with a fix, would be delightful, if this gets merged 🎉: #10893

@balazsorban44
Copy link
Member Author

balazsorban44 commented Mar 9, 2020

For people in the future who ends up here, @timneutkens said:

... Both methods are supported btw, you can provide a full url instead of the object. But we're only showing the object in the docs for now, so good catch 💯

So when you read this, probably either way is accepted, and you have a different issue.

@balazsorban44
Copy link
Member Author

This issue has been automatically locked due to no recent activity. If you are running into a similar issue, please create a new issue with the steps to reproduce. Thank you.

@vercel vercel locked as resolved and limited conversation to collaborators Jan 30, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant