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

Flag to hide description

Abierto
#2,537 4 comentarios 2 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
45/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
csharp
Área
cli

Línea de trabajo

Comienza con RootCommand, CommandLineConfiguration y la ruta de salida de HelpText mostrada en el ejemplo; inspecciona cómo se representan las secciones Description y Usage después de config.Invoke("--help"). La tarea estará terminada cuando exista una forma de suprimir la sección Description:, incluso cuando la descripción esté vacía, manteniendo intacta el resto de la salida de ayuda.

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

Descripción

Hi,

It would be helpful to have a flag or property to control whether the description is included in the generated HelpText output.

In our use case, we are using the HelpText in our documentation, and we don’t want to include the description section—especially when the description is empty.

Here’s a minimal example:

RootCommand              rootCommand = new RootCommand();
CommandLineConfiguration config      = new(rootCommand) {Output = new StringWriter()};
config.Invoke("--help");
Console.Out.WriteLine(config.Output);

Current Output:

Description:

Usage:
  ConsoleApp1 [options]

Options:
  -?, -h, --help  Show help and usage information
  --version       Show version information

It would be great to have a way to suppress the Description: section entirely, for example:

rootCommand.HideDescription = true;

Thanks for the great library!

Lenguaje dominante
C#
Estrellas
3.7k
Forks
434
Merge medio
6 h 27 min
PR fusionados (30 d)
2

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 dotnet/command-line-api

Todos los issues de dotnet/command-line-api

Issues similares

Más issues de C#

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.