Skip to content

Update hyperlink for DefaultPromptFunctionText #13176

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.

Sign up for GitHub

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

Jump to bottom
Merged
adityapatwardhan merged 5 commits into from
Nov 14, 2020
Merged

Update hyperlink for DefaultPromptFunctionText #13176

adityapatwardhan merged 5 commits into from
Nov 14, 2020

Conversation

@yecril71pl
Copy link
Contributor

@yecril71pl yecril71pl commented Jul 15, 2020

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

@ghost ghost assigned TravisEz13 Jul 15, 2020
@KalleOlaviNiemitalo
Copy link

KalleOlaviNiemitalo commented Jul 15, 2020

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

@yecril71pl
Copy link
Contributor Author

yecril71pl commented Jul 15, 2020

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.

@iSazonov 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
@sdwheeler
Copy link
Collaborator

sdwheeler commented Jul 16, 2020

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

@yecril71pl
Copy link
Contributor Author

yecril71pl commented Jul 16, 2020

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

There is no content for HELP PROMPT.

@sdwheeler
Copy link
Collaborator

sdwheeler commented Jul 16, 2020 •
edited
Loading

@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.

@KalleOlaviNiemitalo
Copy link

KalleOlaviNiemitalo commented Jul 16, 2020

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?

@adityapatwardhan
Copy link
Member

adityapatwardhan commented Jul 16, 2020

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

@sdwheeler
Copy link
Collaborator

sdwheeler commented Jul 16, 2020

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

@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.

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

ghost commented Jul 24, 2020

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

@ghost ghost removed the Review - Needed The PR is being reviewed label Jul 24, 2020
adityapatwardhan
adityapatwardhan requested changes Jul 24, 2020
View reviewed changes
@ghost 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
@adityapatwardhan
Copy link
Member

adityapatwardhan commented Jul 24, 2020

@yecril71pl Please have a look at suggested changes.

@ghost 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
@yecril71pl yecril71pl requested review from adityapatwardhan and removed request for davidsmatlak July 24, 2020 19:46
yecril71pl and others added 3 commits July 26, 2020 23:24
@yecril71pl @adityapatwardhan
Redirect to about_Prompts online
94fd279 
Co-authored-by: Aditya Patwardhan <adityap@microsoft.com>
@yecril71pl @adityapatwardhan
Redirect Prompt to about_Prompts online
05a4cf7 
Co-authored-by: Aditya Patwardhan <adityap@microsoft.com>
@yecril71pl
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.
@yecril71pl yecril71pl changed the title Remove hyperlink for DefaultPromptFunctionText Update hyperlink for DefaultPromptFunctionText Jul 26, 2020
@SeeminglyScience SeeminglyScience mentioned this pull request Jul 27, 2020
Closed
@yecril71pl yecril71pl requested a review from vexx32 July 29, 2020 20:02
@adityapatwardhan
Copy link
Member

adityapatwardhan commented Jul 30, 2020

@sdwheeler Can you please review the comment help content.

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

ghost commented Aug 7, 2020

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

@TravisEz13
Copy link
Member

TravisEz13 commented Aug 11, 2020

@sdwheeler #13176 (comment)

@ghost ghost removed the Review - Needed The PR is being reviewed label Aug 11, 2020
vexx32
vexx32 reviewed Aug 12, 2020
View reviewed changes
src/System.Management.Automation/engine/InitialSessionState.cs
Comment on lines 4780 to +4783
# .Link
# https://go.microsoft.com/fwlink/?LinkID=225750
# https://go.microsoft.com/fwlink/?LinkId=2136843
# .Link
# about_Prompts
Copy link
Collaborator

@vexx32 vexx32 Aug 12, 2020

Choose a reason for hiding this comment

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

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)

Copy link
Contributor Author

@yecril71pl yecril71pl Aug 12, 2020

Choose a reason for hiding this comment

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

This is the current declaration and it works.

@yecril71pl yecril71pl requested a review from vexx32 August 12, 2020 08:21
@ghost ghost added the Review - Needed The PR is being reviewed label Aug 19, 2020
@ghost
Copy link

ghost commented Aug 19, 2020

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

@adityapatwardhan 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 ghost removed the Review - Needed The PR is being reviewed label Nov 14, 2020
@adityapatwardhan adityapatwardhan merged commit f13d27b into PowerShell:master Nov 14, 2020
@adityapatwardhan adityapatwardhan added this to the 7.2.0-preview.2 milestone Nov 14, 2020
@adityapatwardhan
Copy link
Member

adityapatwardhan commented Nov 14, 2020

@yecril71pl Thank you for your contribution!

@yecril71pl yecril71pl deleted the patch-3 branch November 15, 2020 12:10
JamesWTruher added a commit to JamesWTruher/PowerShell-1 that referenced this pull request Nov 16, 2020
@JamesWTruher
Revert "Update hyperlink for DefaultPromptFunctionText (PowerShell#…
055b019 
…13176)"

This reverts commit f13d27b.
@rjmholt 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
rjmholt pushed a commit that referenced this pull request Nov 17, 2020
@JamesWTruher
Revert "Update hyperlink for DefaultPromptFunctionText (#13176)" (#…
9ca6be1 
…14107)
@rjmholt rjmholt mentioned this pull request Nov 17, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@adityapatwardhan adityapatwardhan adityapatwardhan approved these changes

@sdwheeler sdwheeler Awaiting requested review from sdwheeler

@vexx32 vexx32 Awaiting requested review from vexx32

Assignees

@adityapatwardhan adityapatwardhan

Labels

CL-NotInBuild Indicates that a PR is reverted and not part of the build.

Projects

None yet

Milestone

7.2.0-preview.2

Development

Successfully merging this pull request may close these issues.

Get-Help Clear-Host -Online gives broken link

8 participants

@yecril71pl @KalleOlaviNiemitalo @sdwheeler @adityapatwardhan @TravisEz13 @vexx32 @rjmholt @iSazonov