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: update usage and resources #886

Merged
merged 10 commits into from
Mar 29, 2024

Merge branch 'master' into update-usage-and-resources

a762092
Select commit
Loading
Failed to load commit list.
Sign in for the full log view
Merged

docs: update usage and resources #886

Merge branch 'master' into update-usage-and-resources
a762092
Select commit
Loading
Failed to load commit list.
GitHub Actions / vale completed Mar 18, 2024 in 0s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (19)

sources/platform/actors/running/usage_and_resources.md|16 col 264| [write-good.Passive] 'be allocated' may be passive voice. Use active voice if you can.
sources/platform/actors/running/usage_and_resources.md|29 col 7| [write-good.TooWordy] 'minimum' is too wordy.
sources/platform/actors/running/usage_and_resources.md|30 col 7| [write-good.TooWordy] 'maximum' is too wordy.
sources/platform/actors/running/usage_and_resources.md|33 col 1| [write-good.Weasel] 'Additionally' is a weasel word!
sources/platform/actors/running/usage_and_resources.md|40 col 37| [write-good.TooWordy] 'multiple' is too wordy.
sources/platform/actors/running/usage_and_resources.md|40 col 83| [write-good.Passive] 'is calculated' may be passive voice. Use active voice if you can.
sources/platform/actors/running/usage_and_resources.md|67 col 103| [write-good.Weasel] 'many' is a weasel word!
sources/platform/actors/running/usage_and_resources.md|86 col 158| [write-good.TooWordy] 'minimum' is too wordy.
sources/platform/actors/running/usage_and_resources.md|100 col 1| [write-good.TooWordy] 'It is' is too wordy.
sources/platform/actors/running/usage_and_resources.md|100 col 24| [write-good.TooWordy] 'multiple' is too wordy.
sources/platform/actors/running/usage_and_resources.md|118 col 161| [write-good.Passive] 'is used' may be passive voice. Use active voice if you can.
sources/platform/actors/running/usage_and_resources.md|119 col 13| [write-good.Passive] 'be used' may be passive voice. Use active voice if you can.
sources/platform/actors/running/usage_and_resources.md|119 col 48| [write-good.Weasel] 'only' is a weasel word!
sources/platform/actors/running/usage_and_resources.md|125 col 29| [Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.
sources/platform/actors/running/usage_and_resources.md|127 col 105| [write-good.Passive] 'are charged' may be passive voice. Use active voice if you can.
sources/platform/actors/running/usage_and_resources.md|139 col 5| [write-good.Passive] 'are calculated' may be passive voice. Use active voice if you can.
sources/platform/actors/running/usage_and_resources.md|142 col 60| [write-good.Passive] 'is used' may be passive voice. Use active voice if you can.
sources/platform/actors/running/usage_and_resources.md|142 col 199| [write-good.TooWordy] 'minimum' is too wordy.
sources/platform/actors/running/usage_and_resources.md|152 col 135| [write-good.Weasel] 'many' is a weasel word!

Filtered Findings (12)

sources/platform/actors/running/usage_and_resources.md|10 col 112| [write-good.TooWordy] 'minimum' is too wordy.
sources/platform/actors/running/usage_and_resources.md|35 col 5| [Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.
sources/platform/actors/running/usage_and_resources.md|46 col 6| [Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.
sources/platform/actors/running/usage_and_resources.md|51 col 109| [write-good.TooWordy] 'it is' is too wordy.
sources/platform/actors/running/usage_and_resources.md|51 col 112| [write-good.Passive] 'is allocated' may be passive voice. Use active voice if you can.
sources/platform/actors/running/usage_and_resources.md|51 col 168| [write-good.Passive] 'is assigned' may be passive voice. Use active voice if you can.
sources/platform/actors/running/usage_and_resources.md|51 col 221| [write-good.Passive] 'be allowed' may be passive voice. Use active voice if you can.
sources/platform/actors/running/usage_and_resources.md|63 col 13| [write-good.Weasel] 'only' is a weasel word!
sources/platform/actors/running/usage_and_resources.md|63 col 48| [write-good.TooWordy] 'multiple' is too wordy.
sources/platform/actors/running/usage_and_resources.md|63 col 126| [Microsoft.GeneralURL] For a general audience, use 'address' rather than 'URL'.
sources/platform/actors/running/usage_and_resources.md|92 col 5| [write-good.TooWordy] 'Maximum' is too wordy.
sources/platform/actors/running/usage_and_resources.md|113 col 24| [write-good.Passive] 'be represented' may be passive voice. Use active voice if you can.

Annotations

Check warning on line 16 in sources/platform/actors/running/usage_and_resources.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sources/platform/actors/running/usage_and_resources.md#L16

[write-good.Passive] 'be allocated' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'be allocated' may be passive voice. Use active voice if you can.", "location": {"path": "sources/platform/actors/running/usage_and_resources.md", "range": {"start": {"line": 16, "column": 264}}}, "severity": "WARNING"}

Check warning on line 29 in sources/platform/actors/running/usage_and_resources.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sources/platform/actors/running/usage_and_resources.md#L29

[write-good.TooWordy] 'minimum' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'minimum' is too wordy.", "location": {"path": "sources/platform/actors/running/usage_and_resources.md", "range": {"start": {"line": 29, "column": 7}}}, "severity": "WARNING"}

Check warning on line 30 in sources/platform/actors/running/usage_and_resources.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sources/platform/actors/running/usage_and_resources.md#L30

[write-good.TooWordy] 'maximum' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'maximum' is too wordy.", "location": {"path": "sources/platform/actors/running/usage_and_resources.md", "range": {"start": {"line": 30, "column": 7}}}, "severity": "WARNING"}

Check warning on line 33 in sources/platform/actors/running/usage_and_resources.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sources/platform/actors/running/usage_and_resources.md#L33

[write-good.Weasel] 'Additionally' is a weasel word!
Raw output
{"message": "[write-good.Weasel] 'Additionally' is a weasel word!", "location": {"path": "sources/platform/actors/running/usage_and_resources.md", "range": {"start": {"line": 33, "column": 1}}}, "severity": "WARNING"}

Check warning on line 40 in sources/platform/actors/running/usage_and_resources.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sources/platform/actors/running/usage_and_resources.md#L40

[write-good.TooWordy] 'multiple' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'multiple' is too wordy.", "location": {"path": "sources/platform/actors/running/usage_and_resources.md", "range": {"start": {"line": 40, "column": 37}}}, "severity": "WARNING"}

Check warning on line 40 in sources/platform/actors/running/usage_and_resources.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sources/platform/actors/running/usage_and_resources.md#L40

[write-good.Passive] 'is calculated' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is calculated' may be passive voice. Use active voice if you can.", "location": {"path": "sources/platform/actors/running/usage_and_resources.md", "range": {"start": {"line": 40, "column": 83}}}, "severity": "WARNING"}

Check warning on line 67 in sources/platform/actors/running/usage_and_resources.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sources/platform/actors/running/usage_and_resources.md#L67

[write-good.Weasel] 'many' is a weasel word!
Raw output
{"message": "[write-good.Weasel] 'many' is a weasel word!", "location": {"path": "sources/platform/actors/running/usage_and_resources.md", "range": {"start": {"line": 67, "column": 103}}}, "severity": "WARNING"}

Check warning on line 86 in sources/platform/actors/running/usage_and_resources.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sources/platform/actors/running/usage_and_resources.md#L86

[write-good.TooWordy] 'minimum' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'minimum' is too wordy.", "location": {"path": "sources/platform/actors/running/usage_and_resources.md", "range": {"start": {"line": 86, "column": 158}}}, "severity": "WARNING"}

Check warning on line 100 in sources/platform/actors/running/usage_and_resources.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sources/platform/actors/running/usage_and_resources.md#L100

[write-good.TooWordy] 'It is' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'It is' is too wordy.", "location": {"path": "sources/platform/actors/running/usage_and_resources.md", "range": {"start": {"line": 100, "column": 1}}}, "severity": "WARNING"}

Check warning on line 100 in sources/platform/actors/running/usage_and_resources.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sources/platform/actors/running/usage_and_resources.md#L100

[write-good.TooWordy] 'multiple' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'multiple' is too wordy.", "location": {"path": "sources/platform/actors/running/usage_and_resources.md", "range": {"start": {"line": 100, "column": 24}}}, "severity": "WARNING"}

Check warning on line 118 in sources/platform/actors/running/usage_and_resources.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sources/platform/actors/running/usage_and_resources.md#L118

[write-good.Passive] 'is used' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is used' may be passive voice. Use active voice if you can.", "location": {"path": "sources/platform/actors/running/usage_and_resources.md", "range": {"start": {"line": 118, "column": 161}}}, "severity": "WARNING"}

Check warning on line 119 in sources/platform/actors/running/usage_and_resources.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sources/platform/actors/running/usage_and_resources.md#L119

[write-good.Passive] 'be used' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'be used' may be passive voice. Use active voice if you can.", "location": {"path": "sources/platform/actors/running/usage_and_resources.md", "range": {"start": {"line": 119, "column": 13}}}, "severity": "WARNING"}

Check warning on line 119 in sources/platform/actors/running/usage_and_resources.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sources/platform/actors/running/usage_and_resources.md#L119

[write-good.Weasel] 'only' is a weasel word!
Raw output
{"message": "[write-good.Weasel] 'only' is a weasel word!", "location": {"path": "sources/platform/actors/running/usage_and_resources.md", "range": {"start": {"line": 119, "column": 48}}}, "severity": "WARNING"}

Check warning on line 125 in sources/platform/actors/running/usage_and_resources.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sources/platform/actors/running/usage_and_resources.md#L125

[Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.
Raw output
{"message": "[Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.", "location": {"path": "sources/platform/actors/running/usage_and_resources.md", "range": {"start": {"line": 125, "column": 29}}}, "severity": "WARNING"}

Check warning on line 127 in sources/platform/actors/running/usage_and_resources.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sources/platform/actors/running/usage_and_resources.md#L127

[write-good.Passive] 'are charged' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'are charged' may be passive voice. Use active voice if you can.", "location": {"path": "sources/platform/actors/running/usage_and_resources.md", "range": {"start": {"line": 127, "column": 105}}}, "severity": "WARNING"}

Check warning on line 139 in sources/platform/actors/running/usage_and_resources.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sources/platform/actors/running/usage_and_resources.md#L139

[write-good.Passive] 'are calculated' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'are calculated' may be passive voice. Use active voice if you can.", "location": {"path": "sources/platform/actors/running/usage_and_resources.md", "range": {"start": {"line": 139, "column": 5}}}, "severity": "WARNING"}

Check warning on line 142 in sources/platform/actors/running/usage_and_resources.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sources/platform/actors/running/usage_and_resources.md#L142

[write-good.Passive] 'is used' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is used' may be passive voice. Use active voice if you can.", "location": {"path": "sources/platform/actors/running/usage_and_resources.md", "range": {"start": {"line": 142, "column": 60}}}, "severity": "WARNING"}

Check warning on line 142 in sources/platform/actors/running/usage_and_resources.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sources/platform/actors/running/usage_and_resources.md#L142

[write-good.TooWordy] 'minimum' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'minimum' is too wordy.", "location": {"path": "sources/platform/actors/running/usage_and_resources.md", "range": {"start": {"line": 142, "column": 199}}}, "severity": "WARNING"}

Check warning on line 152 in sources/platform/actors/running/usage_and_resources.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] sources/platform/actors/running/usage_and_resources.md#L152

[write-good.Weasel] 'many' is a weasel word!
Raw output
{"message": "[write-good.Weasel] 'many' is a weasel word!", "location": {"path": "sources/platform/actors/running/usage_and_resources.md", "range": {"start": {"line": 152, "column": 135}}}, "severity": "WARNING"}