freeCodeCamp / freeCodeCamp/devdocs

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

Aperta
#1,772 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
docs/improvement
Lingua principale
Ruby
Stelle
39.5k
Fork
2.6k
Merge medio
4g 32m
PR unite (30g)
13

Descrizione

# 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)

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Use the linked KMeans documentation page as the reproduction case and inspect how its parameter and attribute descriptions are rendered. Trace the documentation styling or rendering entry point responsible for the displayed names and types. Done means the name and type are separated and visually distinguishable in the scikit-learn documentation.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
scikit-learn
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.