Skip to content

Fix ArgumentCompleter attribute example#4802

Merged
sdwheeler merged 6 commits intoMicrosoftDocs:stagingfrom
marcinsmialek:patch-1
Sep 18, 2019
Merged

Fix ArgumentCompleter attribute example#4802
sdwheeler merged 6 commits intoMicrosoftDocs:stagingfrom
marcinsmialek:patch-1

Conversation

@marcinsmialek
Copy link
Copy Markdown
Contributor

Add missing $parameterName argument to ArgumentCompleter attribute example.
Without this argument, the sample doesn't work.

Version(s) of document impacted

  • Impacts 7 document
  • Impacts 6 document
  • Impacts 5.1 document
  • Impacts 5.0 document
  • Impacts 4.0 document
  • Impacts 3.0 document

Reason(s) for not updating all version of documents

  • The documented feature was introduced in version 5.0 of PowerShell
  • This issue only shows up in version 5.0, 5.1, 6, 7 of the document
  • This PR partially fixes the issue, and issue # tracks the remaining work

Add missing $parameterName argument
@opbld33
Copy link
Copy Markdown

opbld33 commented Sep 18, 2019

Docs Build status updates of commit e800716:

⚠️ Validation status: warnings

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Core/About/about_Functions_Advanced_Parameters.md ⚠️Warning View (powershell-6) Details

reference/6/Microsoft.PowerShell.Core/About/about_Functions_Advanced_Parameters.md

  • [Warning] Metadata with following name(s) are not allowed to be set in Yaml header, or as file level metadata in docfx.json, or as global metadata in docfx.json: locale. They are generated by Docs platform, so the values set in these 3 places will be ignored. Please remove them from all 3 places to resolve the warning.

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

about_Functions_Advanced_Parameters.md contained explicit locale header, which is autogenerated by Docs
@opbld30
Copy link
Copy Markdown

opbld30 commented Sep 18, 2019

Docs Build status updates of commit 5c44300:

✅ Validation status: passed

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Core/About/about_Functions_Advanced_Parameters.md ✅Succeeded View (powershell-6)

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

@opbld30
Copy link
Copy Markdown

opbld30 commented Sep 18, 2019

Docs Build status updates of commit 5337669:

⚠️ Validation status: warnings

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Core/About/about_Functions_Advanced_Parameters.md ⚠️Warning View (powershell-6) Details

reference/6/Microsoft.PowerShell.Core/About/about_Functions_Advanced_Parameters.md

  • [Warning] Metadata with following name(s) are not allowed to be set in Yaml header, or as file level metadata in docfx.json, or as global metadata in docfx.json: locale. They are generated by Docs platform, so the values set in these 3 places will be ignored. Please remove them from all 3 places to resolve the warning.

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

@msftclas
Copy link
Copy Markdown

msftclas commented Sep 18, 2019

CLA assistant check
All CLA requirements met.

@opbld31
Copy link
Copy Markdown

opbld31 commented Sep 18, 2019

Docs Build status updates of commit 355e40e:

⚠️ Validation status: warnings

File Status Preview URL Details
reference/5.0/Microsoft.PowerShell.Core/About/about_Functions_Advanced_Parameters.md ⚠️Warning View (powershell-5.0) Details
reference/5.1/Microsoft.PowerShell.Core/About/about_Functions_Advanced_Parameters.md ⚠️Warning View (powershell-5.1) Details
reference/6/Microsoft.PowerShell.Core/About/about_Functions_Advanced_Parameters.md ⚠️Warning View (powershell-6) Details
reference/7/Microsoft.PowerShell.Core/About/about_Functions_Advanced_Parameters.md ⚠️Warning View (powershell-7) Details
reference/7/Microsoft.PowerShell.Core/About/about_If.md ⚠️Warning View (powershell-7) Details
reference/7/Microsoft.PowerShell.Core/About/about_Operators.md ⚠️Warning View (powershell-7) Details

reference/5.0/Microsoft.PowerShell.Core/About/about_Functions_Advanced_Parameters.md

  • [Warning] Metadata with following name(s) are not allowed to be set in Yaml header, or as file level metadata in docfx.json, or as global metadata in docfx.json: locale. They are generated by Docs platform, so the values set in these 3 places will be ignored. Please remove them from all 3 places to resolve the warning.

reference/5.1/Microsoft.PowerShell.Core/About/about_Functions_Advanced_Parameters.md

  • [Warning] Metadata with following name(s) are not allowed to be set in Yaml header, or as file level metadata in docfx.json, or as global metadata in docfx.json: locale. They are generated by Docs platform, so the values set in these 3 places will be ignored. Please remove them from all 3 places to resolve the warning.

reference/6/Microsoft.PowerShell.Core/About/about_Functions_Advanced_Parameters.md

  • [Warning] Metadata with following name(s) are not allowed to be set in Yaml header, or as file level metadata in docfx.json, or as global metadata in docfx.json: locale. They are generated by Docs platform, so the values set in these 3 places will be ignored. Please remove them from all 3 places to resolve the warning.

reference/7/Microsoft.PowerShell.Core/About/about_Functions_Advanced_Parameters.md

  • [Warning] Metadata with following name(s) are not allowed to be set in Yaml header, or as file level metadata in docfx.json, or as global metadata in docfx.json: locale. They are generated by Docs platform, so the values set in these 3 places will be ignored. Please remove them from all 3 places to resolve the warning.

reference/7/Microsoft.PowerShell.Core/About/about_If.md

  • [Warning] Metadata with following name(s) are not allowed to be set in Yaml header, or as file level metadata in docfx.json, or as global metadata in docfx.json: locale. They are generated by Docs platform, so the values set in these 3 places will be ignored. Please remove them from all 3 places to resolve the warning.

reference/7/Microsoft.PowerShell.Core/About/about_Operators.md

  • [Warning] Metadata with following name(s) are not allowed to be set in Yaml header, or as file level metadata in docfx.json, or as global metadata in docfx.json: locale. They are generated by Docs platform, so the values set in these 3 places will be ignored. Please remove them from all 3 places to resolve the warning.

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

@sdwheeler
Copy link
Copy Markdown
Collaborator

@marcinsmialek Please sign the CLA so we can merge this PR. Thanks.

@marcinsmialek
Copy link
Copy Markdown
Contributor Author

Done 😄

btw, you guys might remove the locale header check, so you don't have to reapply them after people like me remove the header after seeing validation results

@sdwheeler sdwheeler merged commit 1d1ef5d into MicrosoftDocs:staging Sep 18, 2019
@sdwheeler
Copy link
Copy Markdown
Collaborator

@marcinsmialek Thanks. I cover the locale warning in the Contributor Guide. See https://github.com/MicrosoftDocs/PowerShell-Docs/blob/staging/contributing/8-MANAGING-PULL-REQUESTS.md#notes.

I have filed a bug to get that warning removed but I don't control the build code. So we have to live with it for now.

@marcinsmialek marcinsmialek deleted the patch-1 branch March 28, 2021 15:50
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.

6 participants