Don't create the aliases section by default
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 52/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- powershell
- Domain
- documentation
Research direction
Start at the New-MarkdownCommandHelp implementation and trace how it builds the aliases section for a command. Compare the proposed Get-Alias and command metadata approaches, then verify that commands without aliases do not receive an empty section and that existing aliases are handled as intended.
Written by the indexing model from the issue text.
Description
Summary of the new feature / enhancement
When using New-MarkdownCommandHelp to generate a markdown template it includes a section for aliases where the user is expected to fill out the list of aliases. This seems like a poor default value because most commands will not have any aliases so most users will have to remove this section.
Even if we want to keep this section anyway, there's no real reason for users having to fill it out manually when this module could easily find the aliases for each command, either by running Get-Alias or by looking at the command metadata that is used as input to this command.
Proposed technical implementation details (optional)
Run this command in the session: Get-Alias -Definition Set-TimeZone or use the metadata: (Get-Command Set-TimeZone).ImplementingType.GetCustomAttributes([Alias], $true) or for functions: (Get-Command Test).ScriptBlock.Attributes | where TypeId -eq ([Alias])
- Dominant language
- C#
- Stars
- 871
- Forks
- 166
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from PowerShell/platyPS
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
PowerShell/platyPS#868 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
PowerShell/platyPS#857 ·
-
Difficulty 3/5 Half a day Newbie friendliness 68/100
PowerShell/platyPS#867 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 62/100
PowerShell/platyPS#863 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 72/100
PowerShell/platyPS#862 ·
All issues in PowerShell/platyPS
Similar issues
-
devtools
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
clawsweeper:fix-shape-clear clawsweeper:needs-maintainer-review clawsweeper:no-new-fix-pr clawsweeper:not-repro-on-main impact:ux-release-blocker issue-rating: 🦪 silver shellfish P0
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
openclaw/openclaw-windows-node#1843 · 1 comment · 1 reaction ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
-
kind:ux size:S type:bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
elsa-workflows/elsa-foundation#3256 ·
Maintainers usually reply within 1 day
-
[Bug]: Revit selector reads process ids 2000-2099 as years (flaky AgentClientTests.AYearOrAProcessIdSelectsTheHost)Possibly taken @Wurschdhaud claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
pyrevitlabs/pyRevit#3817 ·
Maintainers usually reply within 1 day