freeCodeCamp / freeCodeCamp/devdocs

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

未关闭
#1,772 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
docs/improvement
主要语言
Ruby
星标
39.5k
派生
2.6k
平均合并
4 天 32 分钟
30 天内合并 PR
13

描述

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

贡献指南

打开贡献指南

调研方向

使用链接的 KMeans 文档页面作为复现案例,并检查其参数和属性描述是如何渲染的。追踪负责显示名称和类型的文档样式或渲染入口。完成标准是名称和类型在 scikit-learn 文档中彼此分离且在视觉上可区分。

由索引模型根据 Issue 内容生成。

评估

技术栈
scikit-learn
领域
documentation
Issue 类型
文档
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。