d3 / d3

Bring data to life with SVG, Canvas and HTML. :bar_chart::chart_with_upwards_trend::tada:

Home Page:https://d3js.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

the wrong parameter name at Binning data of d3-array documentation

Benbinbin opened this issue · comments

commented

the parameter name of bin.thresholds is count

but in the next two paragraph use the thresholds as the parameter name

If thresholds is specified ...

If thresholds is not specified ... will have thresholds.length + 1

although it is a minor issue, fixing it will improve readers' understanding of the document

Hey @Benbinbin @mbostock , I really like the project, can I pick this issue?

It’s not incorrect. The value can be any number of things (a count, an array of values, or a function). We used the name count because it’s the most common case.

Edit: but probably calling it thresholds as the most generic name is the right thing to do for the docs.

This issue should be close then?

commented

It’s not incorrect. The value can be any number of things (a count, an array of values, or a function). We used the name count because it’s the most common case.

Edit: but probably calling it thresholds as the most generic name is the right thing to do for the docs.

yep, it's just a small issue in Docs, maybe change the parameter name to thresholds can make the context more consistent and easier for readers to understand.

I did that and rewrote parts of it in 2984f0b. Hope that’s better.