freeCodeCamp / freeCodeCamp/devdocs

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

Ouverte
#1,772 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
docs/improvement
Langage dominant
Ruby
Étoiles
39.5k
Forks
2.6k
Merge moyen
4 j 32 min
PR mergées (30 j)
13

Description

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

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Utilisez la page de documentation KMeans liée comme cas de reproduction et examinez comment les descriptions de ses paramètres et attributs sont rendues. Suivez le point d’entrée du style ou du rendu de la documentation responsable des noms et des types affichés. C’est terminé lorsque le nom et le type sont séparés et visuellement distinguables dans la documentation de scikit-learn.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
scikit-learn
Domaine
documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.