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

Missing parameters implementations for the Update-MarkdownModuleFile command

Đang mở
  • Có gì không ổn?
#867 0 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ó
3/5
Thời gian dự kiến
Nửa ngày
Mức phù hợp với người mới
68/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
csharp
Lĩnh vực
cli, documentation

Hướng nghiên cứu

Start with the UpdateMarkdownModuleFileCommand class, where the issue says the HelpInfoUri and HelpVersion parameters exist but are never used. Compare it with New-MarkdownModuleFile, which already writes these values into the module front matter, and trace how the update path reads the manifest. Done when running Update-MarkdownModuleFile on a changed manifest rewrites Help Version and HelpInfoUri in the existing Test.md.

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

Mô tả

Steps to reproduce

The Update-MarkdownModuleFile command does not honor the HelpInfoUri and HelpVersion parameters (the properties are available in the UpdateMarkdownModuleFileCommand class, but not implemented).

Run New-MarkdownModuleFile with this module manifest snippet for Test.psd1 to create the module Markdown file:

Use ModuleVersion for the HelpVersion parameter.

@{
    RootModule        = 'Test.psm1'
    ModuleVersion     = '1.1.1'
    HelpInfoURI       = 'https://my-fancy-website/Test'
    ...
}

Then run Update-MarkdownModuleFile with an updated manifest snippet:

@{
    RootModule        = 'Test.psm1'
    ModuleVersion     = '2.0.0'
    HelpInfoURI       = 'https://someone-elses-fancy-website/Test'
    ...
}
Expected behavior

When created, front matter for module's Markdown Test.md is as follows:

---
document type: module
Help Version: 1.1.1
HelpInfoUri: https://my-fancy-website/Test
...
---

After running the update command with the updated manifest, the front matter should be as follows:

---
document type: module
Help Version: 2.0.0
HelpInfoUri: https://someone-elses-fancy-website/Test
...
---
Actual behavior

After running the update command, the front matter remains unchanged:

---
document type: module
Help Version: 1.1.1
HelpInfoUri: https://my-fancy-website/Test
...
---
Error details
Environment data
PSVersion                      7.6.6
PSEdition                      Core
GitCommitId                    7.6.6
OS                             Microsoft Windows 10.0.22631
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.4
SerializationVersion           1.1.0.1
WSManStackVersion              3.0
Version

1.0.3

Visuals

No response

Ngôn ngữ chính
C#
Star
870
Fork
166
Không có pull request nào được merge trong 30 ngày

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.