adambard / adambard/learnxinyminutes-docs

[powershell] corrections and feedback

未关闭
#4,498 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Markdown
星标
12.3k
派生
3.7k
平均合并
13 小时 10 分钟
30 天内合并 PR
6

描述

some small suggestions/fixes for the powershell doc:

# corrections

`Write-Host` is used exactly once and never explained. I suggest changing it to `Write-Output` to conform with the rest of the document

The comment for array-deletion seems wrong. It revers to a command called `del`, but actually used is a method called `Remove`.

# Remove arbitrary elements from a array with "del"
$array.Remove($array[2]) # $array is now [1, 2, 3]

# feedback

I was hoping for a little more regarding env-vars. .e.g. how to set them? what datatype is `$env`? when are they reset (when restarting a new terminal, i guess?)? Is it possible to invoke a single command with with a specific env-variable, without setting that variable for the rest of the shell-session?

in one line a `@` is used instead of `$` for a variable, which was a little confusing. The line was `Invoke-DbaQuery @queryParams`. Does `@` have a special meaning here? Is it a typo?

贡献指南

打开贡献指南

调研方向

Start by locating the PowerShell document and the examples containing Write-Host, the array Remove call, $env, and Invoke-DbaQuery @queryParams. Verify the proposed corrections against PowerShell behavior, then determine which environment-variable and splatting explanations belong in the document. Done means the inaccurate comments and confusing examples are corrected and the selected feedback is documented clearly.

由索引模型根据 Issue 内容生成。

评估

技术栈
powershell
领域
documentation
Issue 类型
文档
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。