Skip to content

Fix documentation typos and obsolete references #670

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

Merged
banesullivan merged 1 commit into from
May 29, 2026
Merged

Fix documentation typos and obsolete references #670

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions tutorial/02_mesh/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,11 +238,6 @@ Note how this varies from assigning scalars to each point
pl.add_mesh(other_cube, cmap='coolwarm')
pl.show()

.. note::
We use :func:`pyvista.PolyDataFilters.clean` to merge the faces of
the cube since, by default, the cube is created with unmerged faces
and duplicate points.


Exercises
---------
Expand Down
2 changes: 1 addition & 1 deletion tutorial/02_mesh/exercises/e_read-file.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
# extensions are listed in an internal function:
#
# See https://docs.pyvista.org/api/readers/_autosummary/pyvista.get_reader#pyvista.get_reader
help(pv.core.utilities.reader.get_reader)
help(pv.get_reader)


# %%
Expand Down
2 changes: 1 addition & 1 deletion tutorial/02_mesh/solutions/e_read-file.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
# %%
# PyVista supports a wide variety of file formats. The supported file
# extensions are listed in an internal function:
help(pv.core.utilities.reader.get_reader)
help(pv.get_reader)


# %%
Expand Down
2 changes: 1 addition & 1 deletion tutorial/04_filters/exercises/b_clipping.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@
#
# This option is available for :func:`pyvista.DataSetFilters.clip`,
# :func:`pyvista.DataSetFilters.clip_box`, and
# :func:`pyvista.DataSetFilters.clip_sruface`, but not available when clipping
# :func:`pyvista.DataSetFilters.clip_surface`, but not available when clipping
# by scalar in :func:`pyvista.DataSetFilters.clip_scalar`.

# Input mesh
Expand Down
2 changes: 1 addition & 1 deletion tutorial/04_filters/solutions/b_clipping.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@
#
# This option is available for :func:`pyvista.DataSetFilters.clip`,
# :func:`pyvista.DataSetFilters.clip_box`, and
# :func:`pyvista.DataSetFilters.clip_sruface`, but not available when clipping
# :func:`pyvista.DataSetFilters.clip_surface`, but not available when clipping
# by scalar in :func:`pyvista.DataSetFilters.clip_scalar`.

# Input mesh
Expand Down
Loading