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

Some fixes for README.md, UseSingularNouns.md #213

Merged
merged 1 commit into from
Mar 27, 2024
Merged

Some fixes for README.md, UseSingularNouns.md #213

merged 1 commit into from
Mar 27, 2024

Conversation

Hrxn
Copy link
Contributor

@Hrxn Hrxn commented Mar 27, 2024

PR Summary

  • ReviewUnusedParameter now has configurable options since latest PSScriptAnalyzer release, but the rule overview table did not reflect that yet
  • Use "correct" rule name (PSUseSingularNouns) in example, for consistency with other included rules examples
  • Fixed wrong parameter name in UseSingularNouns.md parameter section [1]
  • Changed order in config example to be more like other built-in rules

[1] This seems to be the correct parameter name:
https://github.com/PowerShell/PSScriptAnalyzer/blob/a0365a56068f711ee1ec08fae11a85fcc1542f8c/Rules/UseSingularNouns.cs#L35-L38

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.

Copy link

Learn Build status updates of commit 9cbdb8c:

✅ Validation status: passed

File Status Preview URL Details
reference/docs-conceptual/PSScriptAnalyzer/Rules/README.md ✅Succeeded View (ps-modules)
reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSingularNouns.md ✅Succeeded View (ps-modules)

For more details, please refer to the build report.

For any questions, please:

Copy link

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).

Copy link
Collaborator

@sdwheeler sdwheeler left a comment

Choose a reason for hiding this comment

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

Thanks for the update

@sdwheeler sdwheeler merged commit 38931dc into MicrosoftDocs:main Mar 27, 2024
3 checks passed
sdwheeler added a commit to sdwheeler/PSScriptAnalyzer that referenced this pull request Mar 27, 2024
JamesWTruher pushed a commit to PowerShell/PSScriptAnalyzer that referenced this pull request Mar 27, 2024
@Taojunshen Taojunshen mentioned this pull request Mar 27, 2024
4 tasks
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