Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Merge-MarkdownHelp expectation when parameter type varies across versions?

Đang mở
  • Có gì không ổn?
#511 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
28/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
markdown, powershell
Lĩnh vực
documentation, tooling

Hướng nghiên cứu

Bắt đầu với platyPSIssue3.zip được cung cấp và tái tạo Merge-MarkdownHelp bằng cách sử dụng bốn thư mục Exchange Server và các tệp New-MailboxImportRequest.md. Kiểm tra đầu ra đã hợp nhất đối với tham số Mailbox và phần SYNTAX; công việc được xem là hoàn tất khi có kết quả nhất quán, được ghi lại cho các giá trị Type, các bộ tham số và các giá trị Applicable khác nhau giữa các phiên bản.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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?

Ngôn ngữ chính
C#
Star
870
Fork
166
Merge trung bình
21 giờ 17 phút
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của PowerShell/platyPS

Tất cả issue của PowerShell/platyPS

Issue tương tự

Thêm issue về C#

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.