Merge-MarkdownHelp expectation when parameter type varies across versions?
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 28/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- markdown, powershell
- Ambito
- documentation, tooling
Direzione di ricerca
Inizia con il file platyPSIssue3.zip fornito e riproduci Merge-MarkdownHelp usando le quattro directory di Exchange Server e i file New-MailboxImportRequest.md. Esamina l'output unito per il parametro Mailbox e la sezione SYNTAX; il lavoro è completo quando esiste un risultato documentato e coerente per i diversi valori di Type, set di parametri e valori di Applicable tra le versioni.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
I wouldn't necessarily call this a bug, but what is the expected Merge-MarkdownHelp result if the Type value of the same parameter in the same cmdlet changes from one version of the product to another (e.g., Exchange 2013 to Exchange 2016)?
For example, the Mailbox parameter in the New-MailboxImportRequest cmdlet. In Exchange 2010 and Exchange 2013, the Type value is MailboxOrMailUserIdParameter. In Exchange 2016 and Exchange 2019, the Type value is MailboxLocationIdParameter. The actual description portions of the parameter is the same across versions.
If you create the following folder structure with the appropriate files:
\Exchange Server 2010\New-MailboxImportRequest.md
\Exchange Server 2013\New-MailboxImportRequest.md
\Exchange Server 2016\New-MailboxImportRequest.md
\Exchange Server 2019\New-MailboxImportRequest.md
And then run the following commands:
$x = "<path>\Exchange Server 2010","<path>\Exchange Server 2013","<path>\Exchange Server 2016","<path>\Exchange Server 2019"
Merge-MarkdownHelp -Path $x -OutputPath "<path>\platyPSissue\Merged" -ExplicitApplicableIfAll
You'll see in the resulting attached output file, the Type value of the Mailbox parameter is MailboxOrMailUserIdParameter only (the 2010/2013 values). Shouldn't the Mailbox parameter contain multiple YAML sections like this?
Type: MailboxOrMailUserIdParameter
Parameter Sets: (All)
Aliases:
Applicable: Exchange Server 2010, Exchange Server 2013
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
Type: MailboxLocationIdParameter
Parameter Sets: (All)
Aliases:
Applicable: Exchange Server 2016, Exchange Server 2019
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
And what about parameter sets in the SYNTAX section? As you can see, the Mailbox parameter only has the MailboxOrMailUserId parameter:
## SYNTAX
New-MailboxImportRequest [-Mailbox] <MailboxOrMailUserIdParameter> ...
Shouldn't there be two parameter sets? And what to call them and/or how to duplicate and tack and identifier on the end of the parameter set name like this?
## SYNTAX
### MailboxOrMailUserId
New-MailboxImportRequest [-Mailbox] <MailboxOrMailUserIdParameter> ...
### MailboxLocationId
New-MailboxImportRequest [-Mailbox] <MailboxLocationIdParameter> ...
And of course, this would change the Applicable values in the YAML sections in the parameter description.
Is this known or expected behavior?
- Lingua principale
- C#
- Stelle
- 871
- Fork
- 166
- Merge medio
- 21h 17m
- PR unite (30g)
- 1
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di PowerShell/platyPS
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
PowerShell/platyPS#857 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 62/100
PowerShell/platyPS#863 ·
-
Export-MamlCommandHelp: a module file in the batch aborts the whole export and writes nothing Aperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 72/100
PowerShell/platyPS#862 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 58/100
PowerShell/platyPS#861 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 64/100
PowerShell/platyPS#860 · 1 commento ·
Tutte le issue di PowerShell/platyPS
Issue simili
-
bug frontend good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
NavigationViewItemAutomationPeer implements IInvokeProvider but never advertises the Invoke pattern Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
unoplatform/uno#24629 ·
-
agentic-workflows Needs: Triage :mag: State: In-PR
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
CS0162 "Unreachable code detected" warning from a MSBuildTemp .tmp file in every game project Apertabug
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
-
Type: enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
apache/arrow-adbc#4809 ·