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

Merged
adityapatwardhan merged 5 commits into from
Nov 14, 2020
Merged

Update hyperlink for DefaultPromptFunctionText #13176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4f0ec37
Remove hyperlink for DefaultPromptFunctionText
yecril71pl Jul 15, 2020
919c337
Remove invalid hyperlink for Prompt
yecril71pl Jul 15, 2020
94fd279
Redirect to about_Prompts online
yecril71pl Jul 26, 2020
05a4cf7
Redirect Prompt to about_Prompts online
yecril71pl Jul 26, 2020
55873fa
Add stub documentation for Prompt
yecril71pl Jul 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion src/System.Management.Automation/engine/InitialSessionState.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4765,8 +4765,22 @@ internal static SessionStateAliasEntry[] BuiltInAliases

internal const string DefaultPromptFunctionText = @"
""PS $($executionContext.SessionState.Path.CurrentLocation)$('>' * ($nestedPromptLevel + 1)) "";
# .ForwardHelpTargetName about_Prompts
# .SYNOPSIS
# The PowerShell command prompt indicates
# that PowerShell is ready to run a command.
# .DESCRIPTION
# To customize the prompt, write a new Prompt function.
# The function is not protected, so you can overwrite it.
# .OUTPUTS
# The Prompt function must return an object.
# As a best practice, return a string
# or an object that is formatted as a string.
# The maximum recommended length is 80 characters.
# .Link
# https://go.microsoft.com/fwlink/?LinkID=225750
# https://go.microsoft.com/fwlink/?LinkId=2136843
# .Link
# about_Prompts
Comment on lines 4780 to +4783
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.

# .ExternalHelp System.Management.Automation.dll-help.xml
";

Expand Down
2 changes: 1 addition & 1 deletion test/powershell/engine/Help/assets/HelpURI/V2Cmdlets.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ Out-Null,https://go.microsoft.com/fwlink/?linkid=2096792
Out-Printer,https://go.microsoft.com/fwlink/?LinkID=2109553
Out-String,https://go.microsoft.com/fwlink/?linkid=2097024
Pop-Location,https://go.microsoft.com/fwlink/?linkid=2096907
Prompt,https://go.microsoft.com/fwlink/?LinkID=225750
Prompt,https://go.microsoft.com/fwlink/?LinkId=2136843
Push-Location,https://go.microsoft.com/fwlink/?linkid=2097105
Read-Host,https://go.microsoft.com/fwlink/?linkid=2096610
Receive-Job,https://go.microsoft.com/fwlink/?linkid=2096965
Expand Down