`ShowCommandHelp` (F1), with fuzzy input, doesn't consistently find all relevant topics, sometimes display single match in a list instead of opening the topic

Abierto
#3,571 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
csharp, powershell
Área
cli

Línea de trabajo

Start by reproducing the F1 ShowCommandHelp cases described in the issue: content, item, and variables in PowerShell 7.4. Check how fuzzy command and about_* topic matches are collected and presented. Done means all relevant matches are found consistently, a single match opens directly, and multiple matches are presented so the user can select a topic.

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

Descripción

Area-CommandHelp Issue-Enhancement
Prerequisites
  • Write a descriptive title.
  • Make sure you are able to repro it on the latest released version
  • Search the existing issues, especially the pinned issues.
Exception report
N/A
Screenshot

N/A

Environment data
PS Version: 7.4.0-preview.1
PS HostName: ConsoleHost
PSReadLine Version: 2.2.6
PSReadLine EditMode: Emacs
OS: Darwin JDoes-MacBook-Pro.local 22.2.0 Darwin Kernel Version 22.2.0: Fri Nov 11 02:03:51 PST 2022; root:xnu-8792.61.2~4/RELEASE_ARM64_T6000 arm64
BufferWidth: 180
BufferHeight: 60
Steps to reproduce

Even though it isn't currently documented, ShowCommandHelp also recognizes parts of conceptual about_* topic titles and partial command names.

However,

  • this recognition is inconsistent
  • sometimes, instead of displaying what is seemingly a single matching topic directly, it is presented in a list as if multiple topics had matched.
# OK: Shows list of matching command help topics: Add-Content, Clear-Content, ...
PS> content # <- press F1 here

# !! about_* topic seemingly SHADOWS command lookup: only about_PSItem is shown, not also Get-Item, ...
PS> item # <- press F1 here

# !! Even though *two* matching about_* topics exist - about_Automatic_Variables and about_Variables - 
# !! only *one* is shown (about_Automatic_Variables), and unexpectedly in a *list* instead of directly.
PS> variables # <- press F1 here

Related issue, specific to language keywords:

  • #3570

Also, with respect to the inability to select a topic of interest when multiple ones match:

  • #3572
Expected behavior

See above.

Actual behavior

See above.

Lenguaje dominante
C#
Estrellas
4.4k
Forks
341
Métricas de merge de PR
Sin PR fusionados en 30 d

Guía de contribución

Abrir la guía de contribución

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/PSReadLine

Todos los issues de PowerShell/PSReadLine

Issues similares

Más issues de C#

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.