freeCodeCamp / freeCodeCamp/devdocs

Scikit-learn: Spacing between parameters or class attributes and their type description

Abierto
#1,772 0 comentarios 0 reacciones 0 asignados Ver en GitHub
docs/improvement
Lenguaje dominante
Ruby
Estrellas
39.5k
Forks
2.6k
Merge medio
4 d 32 min
PR fusionados (30 d)
13

Descripción

# Documentation style bug

## Summary
For scikit-learn docs, there is no space between the parameter or attribute name and their type description. Moreover, they are formatted in the same manner so it is difficult to distinguish what part is the parameter/attribute name and what part is the type description.

## Actual style
For example: [KMeans](https://devdocs.io/scikit_learn/modules/generated/sklearn.cluster.kmeans#sklearn.cluster.KMeans)
![image](https://user-images.githubusercontent.com/47059039/177104490-e39b46e3-a336-4802-8d57-0d39339a4edd.png)
![image](https://user-images.githubusercontent.com/47059039/177104711-61165f69-22b6-4ea0-a5ac-f0e89bb5694d.png)

## Expected style
There should perhaps be a separator like a colon between the parameter/attribute name and the type description.

## Other information
OS: Ubuntu 20.04.1
Browser: Chrome Version 101.0.4951.64 (Official Build) (64-bit)

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Usa la página de documentación de KMeans enlazada como caso de reproducción e inspecciona cómo se renderizan las descripciones de sus parámetros y atributos. Sigue el punto de entrada del estilo o renderizado de la documentación responsable de los nombres y tipos mostrados. Se considera terminado cuando el nombre y el tipo están separados y se distinguen visualmente en la documentación de scikit-learn.

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

Evaluación

Stack tecnológico
scikit-learn
Área
documentation
Tipo de issue
Documentación
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.