-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
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
Conversation
lib/matplotlib/tri/triangulation.py
Outdated
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]``. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
space before x
There was a problem hiding this 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
43ed248
to
b30632f
Compare
thanks |
`edges` | ||
`neighbors` | ||
edges : int array of shape (nedges, 2) | ||
See `~.Triangulation.edges` |
There was a problem hiding this comment.
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
Is there some novel doc interpolation going on? Does this have any additional requirement?
There was a problem hiding this comment.
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).
There was a problem hiding this comment.
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...
There was a problem hiding this comment.
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
PR Summary