XML documentation for SMO objects should have content from the strings files
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- csharp
- Área
- documentation
Línea de trabajo
Comienza examinando cómo codegen produce la documentación XML y cómo se definen los atributos SFC en las propiedades públicas de los facets. Lee la entrada de Smo/LocalizableResources.strings a la que se hace referencia en el issue y sigue el recorrido de cómo se exponen esas cadenas a SSMS. Se considera terminado cuando una herramienta combina el XML generado con la documentación de propiedades extraída, de modo que el XML de NuGet contenga entradas para las propiedades generadas.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Today, properties created by codegen do not have proper documentation
Example:
the XML documentation file included in the nuget package lacks entries for these properties.
To improve the documentation, we should write a tool to merge the C#-generated XML file with content extracted from the SFC attributes on each facet's public properties. Those strings are currently only shown in the SSMS UI for policy-based management.
The strings reside in the strings file, eg:
- Lenguaje dominante
- C#
- Estrellas
- 143
- Forks
- 28
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de microsoft/sqlmanagementobjects
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 72/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 74/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 78/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
Todos los issues de microsoft/sqlmanagementobjects
Issues similares
-
untriaged
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
dotnet/dotnet-api-docs#13095 ·
-
area-deployment area-integrations triage:bot-seen
Dificultad 2/5 Medio día Aptitud para principiantes 86/100
-
type/automation type/tech-debt
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
-
bug
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
newrelic/newrelic-dotnet-agent#3850 · 1 comentario ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
LuckyPennySoftware/AutoMapper#4660 ·