PowerShell / PowerShell/PSScriptAnalyzer

Show documentation on custom rules

Abierto
#1,106 17 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Up-for-Grabs
Lenguaje dominante
C#
Estrellas
2.2k
Forks
414
Merge medio
13 h 1 min
PR fusionados (30 d)
2

Descripción

I have noticed the new support for Show documentation for pops up as a suggested correction. However, when using custom rules this uses this github repo and results in a 404 (e.g. https://github.com/PowerShell/PSScriptAnalyzer/blob/development/RuleDocumentation/Measure-PascalCase.md). Is it possible to use a custom url for this feature? This would allow us to direct the documentation at our own internal spaces.

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.

Línea de trabajo

Comienza rastreando el comportamiento existente de “Show documentation for ” descrito en el issue y cómo las reglas personalizadas resuelven actualmente la URL de ejemplo de RuleDocumentation. La tarea estará completada cuando las reglas personalizadas puedan usar una URL de documentación configurada y dejen de producir un 404 basado en el repositorio.

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

Evaluación

Stack tecnológico
csharp, powershell
Área
tooling
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.