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

axis.x.tick.fit documentation is incorrect (backwards) #1786

Open
Zerim opened this issue Jul 29, 2016 · 3 comments
Open

axis.x.tick.fit documentation is incorrect (backwards) #1786

Zerim opened this issue Jul 29, 2016 · 3 comments

Comments

@Zerim
Copy link

Zerim commented Jul 29, 2016

From the docs:

If true set, the ticks will be positioned nicely. If false set, the ticks will be positioned according to x value of the data points.

In this example however, setting 'fit' to 'true' causes the ticks to be positioned according to the x value of the data points while setting to false actually makes the ticks appear nicely spaced.

@Skotu
Copy link

Skotu commented Aug 1, 2016

"If true set, the ticks will be positioned nicely."

This is true. In given example when fit is set true, it positioned nicely - ticks appear only where data is.
If it's false, ticks have even spacing, but are not necessarily where the exact points are - 'not nicely'.

I think your picture of 'positioned nicely' is simply different than one of the author of documentation.

@Zerim
Copy link
Author

Zerim commented Aug 1, 2016

Hmmm, I can see how the first sentence may be read subjectively. However,

If false, the ticks will be positioned according to the x value of the data points.

This part appears to be objectively incorrect. If set to false the ticks are positioned evenly, without regard to what the x value of the data points are.

In either case the wording should probably be changed to be more explicit.

@mjlangan
Copy link

I, too, was confused by the documentation regarding this feature. "Positioned nicely" is vague language, and the documentation for the false case is indeed just wrong as @Zerim pointed out.

How about changing it to: "If true, ticks will be positioned according to the x value of the data points. If false, ticks will be evenly spaced along the x-axis." It's wordier, but more clear about what to expect from the setting.

@GDFaber GDFaber self-assigned this Apr 11, 2020
@GDFaber GDFaber removed their assignment Mar 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants