Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Missing parameters implementations for the Update-MarkdownModuleFile command

Abierto
  • ¿Algo no está bien?
#867 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
Medio día
Aptitud para principiantes
68/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
csharp
Área
cli, documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
C#
Estrellas
870
Forks
166
Sin PR fusionados en 30 d

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de PowerShell/platyPS

Todos los issues de PowerShell/platyPS

Issues similares

Más issues de C#

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.