Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Update rule docs#1711

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
sdwheeler merged 7 commits intoPowerShell:masterfromsdwheeler:sdw-docs
Sep 29, 2021
Merged

Update rule docs#1711

sdwheeler merged 7 commits intoPowerShell:masterfromsdwheeler:sdw-docs
Sep 29, 2021

Conversation

@sdwheeler
Copy link
Collaborator

@sdwheelersdwheeler commentedAug 31, 2021•
edited
Loading

PR Summary

Updated the README and Rules documentation.

  • Corrected grammar and formatting.
  • Added column to table in README to indicate which rules are enabled by default.
  • Renamed files to match the actual rule names as used by the end-user

PR Checklist

Copy link
Collaborator

@StevenBucher98StevenBucher98 left a comment

Choose a reason for hiding this comment

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

Approved, mostly just formatting changes but did try to read every revised wording, I was looking for grammar and just basic high level things, not really if rules/docs were "correct" because I am unsure about every rule. I learned somethings even reading through :)

@sdwheelersdwheelerenabled auto-merge (squash)September 28, 2021 13:42
Copy link
Member

@SteveL-MSFTSteveL-MSFT left a comment

Choose a reason for hiding this comment

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

about halfway done reviewing, will take time to go through it thoroughly

Comment on lines 78 to 82
The compatibility analysis compares a command used to both a target profile and a "union" profile
(containing all commands available in*any* profile in the profile dir). If a command is not present
in the union profile, it is assumed to be locally created and ignored. Otherwise, if a command is
present in the union profile but not present in a target, it is deemed to be incompatible with that
target.
Copy link
Contributor

Choose a reason for hiding this comment

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

This documentation was written with semantic line breaks in mind. While those aren't used in the docs repos, I think we wish to keep them here.

If a ScriptBlock is intended to be run in a new RunSpace, variables inside it should use the
`$using:` scope modifier, or be initialized within the**ScriptBlock**. This applies to:

-`Invoke-Command`- Only with the**ComputerName** or**Session** parameter.
Copy link
Contributor

Choose a reason for hiding this comment

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

Here I'd suggest-ComputerName etc, in monospace

Copy link
CollaboratorAuthor

Choose a reason for hiding this comment

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

Bold is the style when parameter names are used in a paragraph. Code style is used when the parameter is used in a code context.

##Description

For a file encoded with a format other than ASCII, ensure Byte Order Mark (BOM) is present to ensure that any application consuming this file can interpret it correctly.
For a file encoded with a format other than ASCII, ensure Byte Order Mark (BOM) is present to ensure
Copy link
Member

Choose a reason for hiding this comment

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

Is this still true or do we expect UTF8 (no BOM) now?

Copy link
CollaboratorAuthor

Choose a reason for hiding this comment

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

The rule exists. I guess the question is whether it is or should be applied?

Copy link
Contributor

Choose a reason for hiding this comment

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

@SteveL-MSFT the rule enforces the presence of a BOM.

A script encoded with UTF-8 (no BOM) will be misinterpreted by WinPS as CP-1252.

Seehttps://docs.microsoft.com/powershell/scripting/dev-cross-plat/vscode/understanding-file-encoding

Copy link
Contributor

Choose a reason for hiding this comment

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

(As it happens, that doc page itself has encoding issues around HTML escaping)

bergmeister reacted with laugh emoji
Copy link
CollaboratorAuthor

Choose a reason for hiding this comment

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

Should we add the information about WinPS to the rule doc?

Copy link
CollaboratorAuthor

Choose a reason for hiding this comment

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

@rjmholt FYI - just fixed the html encoding problem in the article. It will be live this afternoon.

rjmholt reacted with thumbs up emoji
sdwheelerand others added3 commitsSeptember 29, 2021 09:12
Co-authored-by: Robert Holt <rjmholt@gmail.com>Co-authored-by: Steve Lee <slee@microsoft.com>
@rjmholt
Copy link
Contributor

@SteveL-MSFT this is set to auto-merge, so when you refresh your review to an approval it will merge

@sdwheelersdwheeler merged commit00bea7a intoPowerShell:masterSep 29, 2021
@sdwheelersdwheeler deleted the sdw-docs branchOctober 4, 2021 17:20
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@SteveL-MSFTSteveL-MSFTSteveL-MSFT approved these changes

@StevenBucher98StevenBucher98StevenBucher98 approved these changes

+1 more reviewer

@rjmholtrjmholtrjmholt approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@sdwheeler@rjmholt@SteveL-MSFT@StevenBucher98
[8]ページ先頭
©2009-2025 Movatter.jp