FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Some doc cleanup of Triangulation by timhoffm · Pull Request #11585 · matplotlib/matplotlib · GitHub

Repository navigation

Some doc cleanup of Triangulation - #11585

Merged
anntzer merged 1 commit into
matplotlib:masterfrom
timhoffm:doc-triangulation
Jul 6, 2018
Merged

anntzer merged 1 commit into
matplotlib:masterfrom
timhoffm:doc-triangulation

Conversation

timhoffm commented Jul 6, 2018

Copy link
Copy Markdown
Member

PR Summary

Comment thread lib/matplotlib/tri/triangulation.py Outdated
The returned array has shape (npoints, 3) and allows z-value at (x, y)
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
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

space before x

anntzer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

one typo left, though

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

anntzer commented Jul 6, 2018

Copy link
Copy Markdown
Contributor

thanks

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

see link to built doc

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
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


Back | FazBrowse Home | New Git URL