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

Docs: Fix misleading console.log output example #41096

Merged
merged 1 commit into from Oct 2, 2022

Conversation

p13lgst
Copy link
Contributor

@p13lgst p13lgst commented Oct 2, 2022

The docs have a misleading console.log output for the input process.env that doesn't display all the variables on edge runtime. The example shows an output of a supposed object with all the environment variables, but it does this when logging a specific variable.

Bug

  • Related issues linked using fixes #number
  • Integration tests added
  • Errors have a helpful link attached, see contributing.md

Feature

  • Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
  • Related issues linked using fixes #number
  • Integration tests added
  • Documentation added
  • Telemetry added. In case of a feature if it's used or not.
  • Errors have a helpful link attached, see contributing.md

Documentation / Examples

  • Make sure the linting passes by running pnpm lint
  • The "examples guidelines" are followed from our contributing doc

Copy link
Member

@ijjk ijjk left a comment

Choose a reason for hiding this comment

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

Good catch, thanks!

@ijjk ijjk merged commit 54d70a0 into vercel:canary Oct 2, 2022
@p13lgst p13lgst deleted the fix-misleading-output-example branch October 2, 2022 01:14
BowlingX pushed a commit to BowlingX/next.js that referenced this pull request Oct 5, 2022
The docs have a misleading `console.log` output for the input
`process.env` that doesn't display all the variables on edge runtime.
The example shows an output of a supposed object with all the
environment variables, but it does this when logging a specific
variable.

## Documentation / Examples

- [ ] Make sure the linting passes by running `pnpm lint`
- [ ] The "examples guidelines" are followed from [our contributing
doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md)
Kikobeats pushed a commit to Kikobeats/next.js that referenced this pull request Oct 24, 2022
The docs have a misleading `console.log` output for the input
`process.env` that doesn't display all the variables on edge runtime.
The example shows an output of a supposed object with all the
environment variables, but it does this when logging a specific
variable.

## Documentation / Examples

- [ ] Make sure the linting passes by running `pnpm lint`
- [ ] The "examples guidelines" are followed from [our contributing
doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md)
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 2, 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 this pull request may close these issues.

None yet

2 participants