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

changed docstring for extract_all_edges() argument use_all_points #4470

Merged
merged 1 commit into from
May 31, 2023

Conversation

VictorGillioz
Copy link
Contributor

@VictorGillioz VictorGillioz commented May 30, 2023

Overview

This PR corrects a small docstring error on an argument of the method extract_all_edges.

9bf77ed#r115259241

Details

According to VTK source code, https://gitlab.kitware.com/vtk/vtk/-/blob/master/Filters/Core/vtkExtractEdges.cxx, lines 432-438 and 332-338, point renumbering does not happen when use_all_point=True. The method's docstring has been modified accordingly.

Copy link
Member

@tkoyama010 tkoyama010 left a comment

Choose a reason for hiding this comment

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

LGTM

@codecov
Copy link

codecov bot commented May 30, 2023

Codecov Report

Merging #4470 (0544f34) into main (99a2b26) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #4470   +/-   ##
=======================================
  Coverage   95.83%   95.83%           
=======================================
  Files          97       97           
  Lines       20910    20910           
=======================================
  Hits        20039    20039           
  Misses        871      871           

Copy link
Member

@banesullivan banesullivan left a comment

Choose a reason for hiding this comment

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

Thanks for clarifying this!

@VictorGillioz
Copy link
Contributor Author

Thank you @banesullivan and @tkoyama010 for your responsiveness!

@tkoyama010 tkoyama010 added the documentation Anything related to the documentation/website label May 30, 2023
@tkoyama010 tkoyama010 merged commit 8987bee into pyvista:main May 31, 2023
23 checks passed
@VictorGillioz VictorGillioz deleted the extract_all_edges_docstring branch May 31, 2023 12:30
@VictorGillioz VictorGillioz restored the extract_all_edges_docstring branch May 31, 2023 12:33
@banesullivan banesullivan mentioned this pull request Jun 30, 2023
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything related to the documentation/website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants