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

Remove unnecessarily misleading clauses w.r.t. environment variable emptiness (#10850) #10851

Merged
merged 2 commits into from
Feb 5, 2024
Merged

Remove unnecessarily misleading clauses w.r.t. environment variable emptiness (#10850) #10851

merged 2 commits into from
Feb 5, 2024

Conversation

brucificus
Copy link
Contributor

PR Summary

This adjusts some wording to not inappropriately state that environment variables cannot be empty strings when they can be empty strings.

PR Checklist

  • Descriptive Title: This PR's title is a synopsis of the changes it proposes.
  • Summary: This PR's summary describes the scope and intent of the change.
  • Contributor's Guide: I have read the contributors guide.
  • Style: This PR adheres to the style guide.

@brucificus
Copy link
Contributor Author

@microsoft-github-policy-service agree

This comment was marked as outdated.

Copy link

github-actions bot commented Feb 3, 2024

Expectations

Thanks for your submission! Here's a quick note to provide you with some context for what to expect from the docs team and the process now that you've submitted a PR. Even if you've contributed to this repo before, we strongly suggest reading this information; it might have changed since you last read it.

To see our process for reviewing PRs, please read our editor's checklist and process for managing pull requests in particular. Below is a brief, high-level summary of what to expect, but our contributor guide has expanded details.

The docs team begins to review your PR if you request them to or if your PR meets these conditions:

  • It is not a draft PR.
  • It does not have a WIP prefix in the title.
  • It passes validation and build steps.
  • It does not have any merge conflicts.
  • You have checked every box in the PR Checklist, indicating you have completed all required steps and marked your PR as Ready to Merge.

You can always request a review at any stage in your authoring process, the docs team is here to help! You do not need to submit a fully polished and finished draft; the docs team can help you get content ready for merge.

While reviewing your PR, the docs team may make suggestions, write comments, and ask questions. When all requirements are satisfied, the docs team marks your PR as Approved and merges it. Once your PR is merged, it is included the next time the documentation is published. For this project, the documentation is published daily at 3 p.m. Pacific Standard Time (PST).

@sdwheeler
Copy link
Contributor

@brucificus Thanks for the contribution. However, the documentation is correct as written. If you set an environment variable to an empty string, that variable is removed. For example:

# TESTVAR does not exist
PS> dir Env:TESTVAR
Get-ChildItem: Cannot find path 'TESTVAR' because it does not exist.
# Create TESTVAR
PS❯ $Env:TESTVAR = 123
PS> dir Env:TESTVAR

Name                           Value
----                           -----
TESTVAR                        123

# Set it to $null and see that it no longer exists
PS❯ $Env:TESTVAR = $null
PS> dir Env:TESTVAR
Get-ChildItem: Cannot find path 'TESTVAR' because it does not exist.
PS❯ $Env:TESTVAR = ''
PS> dir Env:TESTVAR
Get-ChildItem: Cannot find path 'TESTVAR' because it does not exist.

@sdwheeler sdwheeler reopened this Feb 5, 2024

This comment was marked as outdated.

Copy link
Contributor

Learn Build status updates of commit 0a32fce:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/About/about_Environment_Variables.md ✅Succeeded View (powershell-5.1)
reference/7.2/Microsoft.PowerShell.Core/About/about_Environment_Variables.md ✅Succeeded View (powershell-7.2)
reference/7.3/Microsoft.PowerShell.Core/About/about_Environment_Variables.md ✅Succeeded View (powershell-7.3)
reference/7.4/Microsoft.PowerShell.Core/About/about_Environment_Variables.md ✅Succeeded View (powershell-7.4)
reference/7.5/Microsoft.PowerShell.Core/About/about_Environment_Variables.md ✅Succeeded View (powershell-7.5)

For more details, please refer to the build report.

For any questions, please:

@sdwheeler sdwheeler merged commit 7d769c9 into MicrosoftDocs:main Feb 5, 2024
4 checks passed
@brucificus brucificus deleted the fix_env_var_emptiness_wording branch February 12, 2024 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants