Update hyperlink for DefaultPromptFunctionText by yecril71pl · Pull Request #13176 · PowerShell/PowerShell · GitHub

PR Summary

The help hyperlink for DefaultPromptFunctionText, and hence Prompt, was invalid. Fix #7795.

PR Context

Invalid hyperlinks distract and annoy users and decrease productivity.

PR Checklist

PR has a meaningful title
- Use the present tense and imperative mood when describing your changes
Summarized changes
Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
This PR is ready to merge and is not Work in Progress.
- If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
Breaking changes
- None
- OR
- Experimental feature(s) needed
  - Experimental feature name(s):
User-facing changes
- Not Applicable
- OR
- Documentation needed
  - Issue filed:
Testing - New and feature
- N/A or can only be tested interactively
- OR
- Make sure you've added a new test if existing tests do not effectively test the code changed
Tooling
- I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
- OR
- I have considered the user experience from a tooling perspective and enumerated concerns in the summary. This may include:
  - Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode (which runs in a different PS Host).
  - Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
  - Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
  - Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).

The hyperlink was invalid. Fix PowerShell#7795.

The same URL is here as well:

PowerShell/test/powershell/engine/Help/assets/HelpURI/V2Cmdlets.csv

Line 154 in 9d05561

Prompt,https://go.microsoft.com/fwlink/?LinkID=225750

The same URL is here as well:

PowerShell/test/powershell/engine/Help/assets/HelpURI/V2Cmdlets.csv

Line 154 in 9d05561

Prompt,https://go.microsoft.com/fwlink/?LinkID=225750

This is a test data source. The test HelpSystem.OnlineHelp.Tests.ps1 is too weak—it does not verify that the help content makes sense.

We should not remove this URL we need to fix it.

We should not remove this URL we need to fix it.

There is no content for HELP PROMPT.

Aditya Patwardhan (@adityapatwardhan) Do we want to fix the help for prompt or remove the link?

If we want to fix it, we need to create a new FWLink. The target for that link should point to about_prompts or we need to create a new Microsoft.PowerShell.Core/prompt.md file.

If we want to fix it, we need to create a new FWLink.

Would that make the existing URL redirect correctly (and thus fix PowerShell 6.2.7 as well), or would it require changing the LinkID=225750 number?

Sean Wheeler (@sdwheeler) I think we should fix the help content. Could you just update this link to point to the new content?

The existing FWLink LinkID=225750 does not exist anymore and cannot be recreated. We have to create a new one.

Aditya Patwardhan (@adityapatwardhan) Should we document the prompt function (new content) or point to about_Prompts? about_Prompts is more useful information and the plain function syntax that would be returned.

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

Christopher Yeleighton (@yecril71pl) Please have a look at suggested changes.

Co-authored-by: Aditya Patwardhan <adityap@microsoft.com>

The help should be redirected to about_Prompts but it does not work for some reason, so I copied the most important information from there and added a link to full documentation.

Sean Wheeler (@sdwheeler) Can you please review the comment help content.

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

Sean Wheeler (@sdwheeler) #13176 (comment)

Don't these help nodes require it to be all uppercase? Or am I misremembering. All the help docs I can recall show them only with uppercase names (i.e., .LINK)

This is the current declaration and it works.

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

Christopher Yeleighton (@yecril71pl) Thank you for your contribution!

…13176)" This reverts commit f13d27b.

…14107)

…13176)" (PowerShell#14107)

Remove hyperlink for DefaultPromptFunctionText

4f0ec37

The hyperlink was invalid. Fix PowerShell#7795.

ghost assigned Travis Plunk (TravisEz13) Jul 15, 2020

Remove invalid hyperlink for Prompt

919c337

Ilya (iSazonov) requested review from David Smatlak (davidsmatlak) and Sean Wheeler (sdwheeler) July 16, 2020 07:05

Ilya (iSazonov) added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Jul 16, 2020

ghost added the Review - Needed The PR is being reviewed label Jul 24, 2020

Aditya Patwardhan (adityapatwardhan) assigned Aditya Patwardhan (adityapatwardhan) and unassigned Travis Plunk (TravisEz13) Jul 24, 2020

ghost removed the Review - Needed The PR is being reviewed label Jul 24, 2020

Aditya Patwardhan (adityapatwardhan) requested changes Jul 24, 2020

View reviewed changes

Comment thread src/System.Management.Automation/engine/InitialSessionState.cs

Comment thread test/powershell/engine/Help/assets/HelpURI/V2Cmdlets.csv

ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jul 24, 2020

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jul 24, 2020

Christopher Yeleighton (yecril71pl) requested review from Aditya Patwardhan (adityapatwardhan) and removed request for David Smatlak (davidsmatlak) July 24, 2020 19:46

Christopher Yeleighton (yecril71pl) and others added 3 commits July 26, 2020 23:24

Redirect to about_Prompts online

94fd279

Co-authored-by: Aditya Patwardhan <adityap@microsoft.com>

Redirect Prompt to about_Prompts online

05a4cf7

Co-authored-by: Aditya Patwardhan <adityap@microsoft.com>

Add stub documentation for Prompt

55873fa

The help should be redirected to about_Prompts but it does not work for some reason, so I copied the most important information from there and added a link to full documentation.

Christopher Yeleighton (yecril71pl) changed the title Remove hyperlink for DefaultPromptFunctionText Update hyperlink for DefaultPromptFunctionText Jul 26, 2020

Patrick Meinecke (SeeminglyScience) mentioned this pull request Jul 27, 2020

.FORWARDHELPTARGETNAME: cannot forward to ABOUT #13283

Closed

Christopher Yeleighton (yecril71pl) requested a review from Rain Sallow (/u/ta11ow) (vexx32) July 29, 2020 20:02

ghost added the Review - Needed The PR is being reviewed label Aug 7, 2020

ghost removed the Review - Needed The PR is being reviewed label Aug 11, 2020

Rain Sallow (/u/ta11ow) (vexx32) reviewed Aug 12, 2020

View reviewed changes

Christopher Yeleighton (yecril71pl) requested a review from Rain Sallow (/u/ta11ow) (vexx32) August 12, 2020 08:21

ghost added the Review - Needed The PR is being reviewed label Aug 19, 2020

Aditya Patwardhan (adityapatwardhan) approved these changes Nov 14, 2020

View reviewed changes

Aditya Patwardhan (adityapatwardhan) added CL-Engine Indicates that a PR should be marked as an engine change in the Change Log and removed CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log labels Nov 14, 2020

ghost removed the Review - Needed The PR is being reviewed label Nov 14, 2020

Aditya Patwardhan (adityapatwardhan) merged commit f13d27b into PowerShell:master Nov 14, 2020

Aditya Patwardhan (adityapatwardhan) added this to the 7.2.0-preview.2 milestone Nov 14, 2020

Christopher Yeleighton (yecril71pl) deleted the patch-3 branch November 15, 2020 12:10

James Truher (JamesWTruher) added a commit to JamesWTruher/PowerShell-1 that referenced this pull request Nov 16, 2020

Revert "Update hyperlink for DefaultPromptFunctionText (PowerShell#…

055b019

…13176)" This reverts commit f13d27b.

Rob Holt (rjmholt) added CL-NotInBuild Indicates that a PR is reverted and not part of the build. and removed CL-Engine Indicates that a PR should be marked as an engine change in the Change Log labels Nov 17, 2020

Rob Holt (rjmholt) pushed a commit that referenced this pull request Nov 17, 2020

Revert "Update hyperlink for DefaultPromptFunctionText (#13176 )" (#…

9ca6be1

…14107)

Rob Holt (rjmholt) mentioned this pull request Nov 17, 2020

Get-Help Clear-Host -Online gives broken link #7795

Closed

Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj/PowerShell that referenced this pull request Aug 6, 2026

Update hyperlink for DefaultPromptFunctionText (PowerShell#13176 )

a1b7b84

Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj/PowerShell that referenced this pull request Aug 6, 2026

Revert "Update hyperlink for DefaultPromptFunctionText (PowerShell#…

91a12bd

…13176)" (PowerShell#14107)

               # .Link
-              # https://go.microsoft.com/fwlink/?LinkID=225750
+              # https://go.microsoft.com/fwlink/?LinkId=2136843
+              # .Link
+              # about_Prompts

Update hyperlink for DefaultPromptFunctionText by yecril71pl · Pull Request #13176 · PowerShell/PowerShell · GitHub

Uh oh!

Update hyperlink for DefaultPromptFunctionText - #13176

Update hyperlink for DefaultPromptFunctionText#13176Aditya Patwardhan (adityapatwardhan) merged 5 commits intoPowerShell:masterPowerShell/PowerShell:masterfrom yecril71pl:patch-3yecril71pl/PowerShell:patch-3Copy head branch name to clipboard

Conversation

Christopher Yeleighton (yecril71pl) commented Jul 15, 2020

PR Summary

PR Context

PR Checklist

Uh oh!

Kalle Olavi Niemitalo (KalleOlaviNiemitalo) commented Jul 15, 2020

Uh oh!

Christopher Yeleighton (yecril71pl) commented Jul 15, 2020

Uh oh!

Sean Wheeler (sdwheeler) commented Jul 16, 2020

Uh oh!

Christopher Yeleighton (yecril71pl) commented Jul 16, 2020

Uh oh!

Sean Wheeler (sdwheeler) commented Jul 16, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Kalle Olavi Niemitalo (KalleOlaviNiemitalo) commented Jul 16, 2020

Uh oh!

Aditya Patwardhan (adityapatwardhan) commented Jul 16, 2020

Uh oh!

Sean Wheeler (sdwheeler) commented Jul 16, 2020

Uh oh!

Deleted user (ghost) commented Jul 24, 2020

Uh oh!

Uh oh!

Uh oh!

Aditya Patwardhan (adityapatwardhan) commented Jul 24, 2020

Uh oh!

Aditya Patwardhan (adityapatwardhan) commented Jul 30, 2020

Uh oh!

Deleted user (ghost) commented Aug 7, 2020

Uh oh!

Travis Plunk (TravisEz13) commented Aug 11, 2020

Uh oh!

Rain Sallow (/u/ta11ow) (vexx32) Aug 12, 2020

Choose a reason for hiding this comment

Uh oh!

Christopher Yeleighton (yecril71pl) Aug 12, 2020

Choose a reason for hiding this comment

Uh oh!

Deleted user (ghost) commented Aug 19, 2020

Uh oh!

Aditya Patwardhan (adityapatwardhan) commented Nov 14, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Update hyperlink for DefaultPromptFunctionText#13176
Aditya Patwardhan (adityapatwardhan) merged 5 commits into
PowerShell:masterfrom
yecril71pl:patch-3

Sean Wheeler (sdwheeler) commented Jul 16, 2020 •
edited
Loading