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

(#3401) Update Proxy documentation #3414

Merged
merged 1 commit into from
Apr 19, 2024

Conversation

corbob
Copy link
Member

@corbob corbob commented Apr 5, 2024

Description Of Changes

Update the wording of the Proxy help output to be clear about what is expected.

Motivation and Context

The help output is not clear that Proxy Bypass List is expected to be a regular expression.

Testing

  1. Ran build script.
  2. Ran GenerateDocs.ps1
  3. Copied files over to chocolatey/docs repository to verify updates.

Operating Systems Testing

N/A This is just an update to the help output/docs.

Change Types Made

  • Bug fix (non-breaking change).
  • Feature / Enhancement (non-breaking change).
  • Breaking change (fix or feature that could cause existing functionality to change).
  • Documentation changes.
  • PowerShell code changes.

Change Checklist

  • Requires a change to the documentation.
  • Documentation has been updated.
  • Tests to cover my changes, have been added.
  • All new and existing tests passed?
  • PowerShell code changes: PowerShell v2 compatibility checked?

Related Issue

@corbob corbob self-assigned this Apr 5, 2024
@corbob corbob marked this pull request as draft April 5, 2024 00:48
@corbob corbob marked this pull request as ready for review April 5, 2024 00:50
@corbob
Copy link
Member Author

corbob commented Apr 5, 2024

I was going back and forth on how to review these PRs, hence why it was ready, then draft, now ready again. I have settled upon this review proposal:

  1. This PR is reviewed for the wording update of the proxy help output.
  2. Any changes to the wording are run through GenerateDocs.ps1 and copied over to the Docs PR.
  3. After this PR is merged: the Docs PR ((#954) Enhance and clarify proxy bypass list documentation docs#958) is updated to clean up the commits for a final review/merge.

@gep13
Copy link
Member

gep13 commented Apr 19, 2024

@vexx32 can I ask that you put your eyes on this PR, and provide any feedback. Thanks!

Copy link
Member

@vexx32 vexx32 left a comment

Choose a reason for hiding this comment

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

Mostly good here I think, one minor adjustment to wording I think might be a good idea.

Copy link
Member

@vexx32 vexx32 left a comment

Choose a reason for hiding this comment

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

Looks good to me :3

@vexx32 vexx32 merged commit 3c77b7c into chocolatey:develop Apr 19, 2024
4 of 5 checks passed
@corbob corbob deleted the update-proxy-wording branch April 19, 2024 20:40
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.

Clarify Proxy BypassList value must be a regular expression, in the help output
3 participants