freeCodeCamp / freeCodeCamp/devdocs

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

オープン
#1,772 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
docs/improvement
主要言語
Ruby
スター
39.5k
フォーク
2.6k
平均マージ
4日 32分
マージ済み PR(30日)
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)

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

評価

技術スタック
scikit-learn
領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。