Skip to content

Fix New-TemporaryFile online help URI #6608

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
TravisEz13 merged 1 commit into from
Jun 20, 2018
Merged

Fix New-TemporaryFile online help URI #6608

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion src/Microsoft.PowerShell.Commands.Utility/commands/utility/NewTemporaryFileCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ namespace Microsoft.PowerShell.Commands
/// <summary>
/// The implementation of the "New-TemporaryFile" cmdlet
/// </summary>
[Cmdlet(VerbsCommon.New, "TemporaryFile", SupportsShouldProcess = true, HelpUri = "https://go.microsoft.com/fwlink/?LinkId=526726")]
[Cmdlet(VerbsCommon.New, "TemporaryFile", SupportsShouldProcess = true, HelpUri = "https://go.microsoft.com/fwlink/?LinkId=821836")]
Copy link
Copy Markdown
Contributor

@dantraMSFT dantraMSFT Apr 9, 2018

Choose a reason for hiding this comment

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

This like resolves to PowerShell 5.1 (https://docs.microsoft.com/en-us/powershell/module/Microsoft.PowerShell.Utility/New-TemporaryFile?view=powershell-5.1) There is a PowerShell 6 page for this cmdlet (https://docs.microsoft.com/en-us/powershell/module/Microsoft.PowerShell.Utility/New-TemporaryFile?view=powershell-6)

Copy link
Copy Markdown
Member Author

@adityapatwardhan adityapatwardhan Apr 9, 2018

Choose a reason for hiding this comment

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

For most of our cmdlets we default to 5.1. @joeyaiello Are we going to change the default to 6?

Copy link
Copy Markdown
Contributor

@joeyaiello joeyaiello Apr 11, 2018

Choose a reason for hiding this comment

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

So the new fwlink points to 5.1, and IMO it should probably point to the version-agnostic link (for which we can change the default later). This way, when we update to 6, we can rev the default for all modules on docs.microsoft.com to 6.1, and then we don't have to change the fwlinks.

However, if we go that route, we need to make sure that 6 has distinct fwlinks from 5.1, and i'm not sure we've got that work fully understood or costed (that's a lot of fwlinks).

[OutputType(typeof(System.IO.FileInfo))]
public class NewTemporaryFileCommand : Cmdlet
{
Expand Down
2 changes: 1 addition & 1 deletion test/powershell/engine/Help/assets/HelpURI/V3Cmdlets.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Enter-PSHostProcess,https://go.microsoft.com/fwlink/?LinkId=403736
Exit-PSHostProcess,https://go.microsoft.com/fwlink/?LinkId=403737
Clear-RecycleBin,https://go.microsoft.com/fwlink/?LinkId=524082
ConvertFrom-String,https://go.microsoft.com/fwlink/?LinkId=507579
New-TemporaryFile,https://go.microsoft.com/fwlink/?LinkId=526726
New-TemporaryFile,https://go.microsoft.com/fwlink/?LinkId=821836
New-Guid,https://go.microsoft.com/fwlink/?LinkId=526920
Format-Hex,https://go.microsoft.com/fwlink/?LinkId=526919
Convert-String,https://go.microsoft.com/fwlink/?LinkId=528577
Expand Down