8000 Grammar fix for pyplot tutorial by brettcannon · Pull Request #4963 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Grammar fix for pyplot tutorial #4963

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Aug 19, 2015
Merged

Grammar fix for pyplot tutorial #4963

merged 1 commit into from
Aug 19, 2015

Conversation

brettcannon
Copy link
Contributor

"an axes" -> "any axes"

@brettcannon
Grammar fix
8cf64d1 
"an axes" -> "any axes"
WeatherGod added a commit that referenced this pull request Aug 19, 2015
@WeatherGod
Merge pull request #4963 from brettcannon/patch-1
6293f20 
Grammar fix for pyplot tutorial
@WeatherGod WeatherGod merged commit 6293f20 into matplotlib:master Aug 19, 2015
@WeatherGod
Copy link
Member

Thanks! Doc-fixes are greatly appreciated! If you find more, send 'em over.

@brettcannon
Copy link
Contributor Author

So I have a question about using the term axes. I'm noticing that in a bunch of places it's used as a singular thing, such as "Add an axes to the figure" in the matplotlib.pyplot.axes docs. But I'm used to the plural meaning of "axes", like "add axes to the figure" because you're adding more than one axis. Which is the way you prefer? If it's the latter then I'm happy to send in PRs changing the grammar as I read through the user's guide (this has been the only consistent quirk that's throwing me as a new user with no MATLAB background if that's the reason for the phrasing choice).

@WeatherGod
Copy link
Member

Yes, this is a perennial problem. The issue is that there is a concept of
an "axis" (i.e., the x-axis and y-axis). So, a plot is composed of 2 or
more axis-es. Hence, a plot is known as an "axes". So, we try and avoid
saying "axes" when we mean multiple "axis" (but that gets tricky). We
almost never say "axis" when we mean a single "axes".

English is a terrible programming language...

On Wed, Aug 19, 2015 at 1:44 PM, Brett Cannon notifications@github.com
wrote:

So I have a question about usi 8000 ng the term axes. I'm noticing that in a
bunch of places it's used as a singular thing, such as "Add an axes to the
figure" in the matplotlib.pyplot.axes docs
http://matplotlib.org/api/pyplot_api.html#matplotlib.pyplot.axes. But
I'm used to the plural meaning of "axes", like "add axes to the figure"
because you're adding more than one axis. Which is the way you prefer? If
it's the latter then I'm happy to send in PRs changing the grammar as I
read through the user's guide (this has been the only consistent quirk
that's throwing me as a new user with no MATLAB background if that's the
reason for the phrasing choice).

—
Reply to this email directly or view it on GitHub
#4963 (comment)
.

@tacaswell
Copy link
Member

@brettcannon I hope http://matplotlib.org/faq/usage_faq.html#parts-of-a-figure clarifies things.

Grammatically would it make more sense to say "Add an axes object to the figure"?

@dopplershift
Copy link
Contributor

That sounds better to me.

@WeatherGod
Copy link
Member

And what shall be the plural of axis and axes?

On Wed, Aug 19, 2015 at 2:08 PM, Ryan May notifications@github.com wrote:

That sounds better to me.

—
Reply to this email directly or view it on GitHub
#4963 (comment)
.

@dopplershift
Copy link
Contributor

"objects"

@brettcannon
Copy link
Contributor Author

The FAQ entry from @tacaswell does help explain why the docs use "axes" as a singular term. Is this a MATPLOTLIB thing?

Anyway, what I'll do is send a PR that tweaks the Pyplot tutorial to link to the FAQ entry so that it makes more sense to beginners.

@efiring
Copy link
Member
efiring commented Aug 19, 2015

On 2015/08/19 8:04 AM, Thomas A Caswell wrote:

@brettcannon https://github.com/brettcannon I hope
http://matplotlib.org/faq/usage_faq.html#parts-of-a-figure clarifies
things.

Grammatically would it make more sense to say "Add an |axes| object to
the figure"?

Maybe this should be consistently capitalized, "Axes", to be a more
explicit reference to the Axes class.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
4356
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@brettcannon @WeatherGod @tacaswell @dopplershift @efiring
0