microsoft / microsoft/sqlmanagementobjects

XML documentation for SMO objects should have content from the strings files

Abierto
#97 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
C#
Estrellas
143
Forks
28
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Today, properties created by codegen do not have proper documentation
Example:

https://docs.microsoft.com/dotnet/api/microsoft.sqlserver.management.smo.database.azureedition?view=sql-smo-160

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:

https://github.com/microsoft/sqlmanagementobjects/blob/f68bac8d8f651ab5415ef53b81c817677e668c28/src/Microsoft/SqlServer/Management/Smo/LocalizableResources.strings#L657

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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 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.

Evaluación

Stack tecnológico
csharp
Área
documentation
Tipo de issue
Documentación
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.