Skip to content

Some doc cleanup of Triangulation #11585

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

Merged
merged 1 commit into from
Jul 6, 2018

Conversation

timhoffm
Copy link
Member

@timhoffm timhoffm commented Jul 6, 2018

PR Summary

position in triangle tri to be calculated using
z = array[tri,0]*x + array[tri,1]*y + array[tri,2].
``z = array[tri, 0] *x + array[tri, 1] * y + array[tri, 2]``.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

space before x

Copy link
Contributor

@anntzer anntzer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one typo left, though

@timhoffm timhoffm force-pushed the doc-triangulation branch from 43ed248 to b30632f Compare July 6, 2018 09:49
@anntzer anntzer added this to the v3.0 milestone Jul 6, 2018
@anntzer anntzer merged commit 5dc51e0 into matplotlib:master Jul 6, 2018
@anntzer
Copy link
Contributor

anntzer commented Jul 6, 2018

thanks

@timhoffm timhoffm deleted the doc-triangulation branch July 6, 2018 21:54
`edges`
`neighbors`
edges : int array of shape (nedges, 2)
See `~.Triangulation.edges`

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line is throwing an error for me when building the docs locally.

d:\...\matplotlib\lib\matplotlib\tri\triangulation.py:docstring of matplotlib.tri.Triangulation:40: toctree references unknown document 'api/matplotlib.tri.Triangulation.edges'

I wonder anyways why

   edges : int array of shape (nedges, 2)
        See `~.Triangulation.edges`

translates into

image

see link to built doc

Is there some novel doc interpolation going on? Does this have any additional requirement?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can not reproduce this locally.

Can you check for stale build products? What version of Matplotlib do you have installed (as the docs are built against the installed version).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The built documentation seems to be pulled from the docstring on the edges property below. The issues maybe different versions of numpydoc behaving differently...

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, thanks for the hint. I update the requirement in #11667

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

Successfully merging this pull request may close these issues.

4 participants