Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Merge-MarkdownHelp expectation when parameter type varies across versions?

オープン
  • 何か問題がありますか？
#511 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
28/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
markdown, powershell
領域
documentation, tooling

調査の方向性

提供された platyPSIssue3.zip から始め、4 つの Exchange Server ディレクトリと New-MailboxImportRequest.md ファイルを使用して Merge-MarkdownHelp を再現します。マージされた出力で Mailbox パラメーターと SYNTAX セクションを確認します。完了の条件は、バージョン間で異なる Type 値、パラメーター セット、および Applicable 値について、文書化された一貫した結果が得られることです。

索引モデルが issue の本文から書いたものです。

説明

Area-MergeMarkdown

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

platyPSIssue3.zip

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?

主要言語
C#
スター
870
フォーク
166
平均マージ
21時間 17分
マージ済み PR（30日）
1

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

PowerShell/platyPS のほかの issue

PowerShell/platyPS の issue をすべて見る

似ている issue

C# の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。