Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
Benbinbin opened this issue Mar 8, 2024 · 5 comments
Closed

Comments

@Benbinbin
Copy link

Benbinbin commented Mar 8, 2024

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

@AlejandroBlanco2001
Copy link

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

@mbostock
Copy link
Member

mbostock commented Apr 9, 2024

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.

@AlejandroBlanco2001
Copy link

This issue should be close then?

@Benbinbin
Copy link
Author

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.

@mbostock
Copy link
Member

mbostock commented Apr 9, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

3 participants