freeCodeCamp / freeCodeCamp/devdocs

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

Open
#1,772 0 comments 0 reactions 0 assignees View on GitHub
docs/improvement
Dominant language
Ruby
Stars
39.5k
Forks
2.6k
Avg merge
4d 32m
Merged PRs (30d)
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)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.