Skip to content

Commit

Permalink
Use a docstring length of 75 (#4129)
Browse files Browse the repository at this point in the history 
* docstring length to 79

* back to 75 char

* Apply suggestions from code review

Co-authored-by: MatthewFlamm <39341281+MatthewFlamm@users.noreply.github.com>

* clean up docstrings

---------

Co-authored-by: MatthewFlamm <39341281+MatthewFlamm@users.noreply.github.com>
  • Loading branch information
@akaszynski @MatthewFlamm
akaszynski and MatthewFlamm committed Mar 15, 2023
1 parent 2096a0a commit 635052d
Show file tree
Hide file tree
Showing 38 changed files with 951 additions and 278 deletions.
104 changes: 84 additions & 20 deletions pyvista/core/composite.py
View file
Expand Up @@ -60,13 +60,20 @@ class MultiBlock(
Instantiate from a list of objects.
>>> data = [pv.Sphere(center=(2, 0, 0)), pv.Cube(center=(0, 2, 0)), pv.Cone()]
>>> data = [
... pv.Sphere(center=(2, 0, 0)),
... pv.Cube(center=(0, 2, 0)),
... pv.Cone(),
... ]
>>> blocks = pv.MultiBlock(data)
>>> blocks.plot()
Instantiate from a dictionary.
>>> data = {"cube": pv.Cube(), "sphere": pv.Sphere(center=(2, 2, 0))}
>>> data = {
... "cube": pv.Cube(),
... "sphere": pv.Sphere(center=(2, 2, 0)),
... }
>>> blocks = pv.MultiBlock(data)
>>> blocks.plot()
Expand All @@ -77,7 +84,8 @@ class MultiBlock(
...
>>> for block in blocks:
... surf = block.extract_surface() # Do something with each dataset
... # Do something with each dataset
... surf = block.extract_surface()
...
"""
Expand Down Expand Up @@ -147,7 +155,11 @@ def bounds(self) -> BoundsLike:
Return the bounds across blocks.
>>> import pyvista as pv
>>> data = [pv.Sphere(center=(2, 0, 0)), pv.Cube(center=(0, 2, 0)), pv.Cone()]
>>> data = [
... pv.Sphere(center=(2, 0, 0)),
... pv.Cube(center=(0, 2, 0)),
... pv.Cone(),
... ]
>>> blocks = pv.MultiBlock(data)
>>> blocks.bounds
(-0.5, 2.5, -0.5, 2.5, -0.5, 0.5)
Expand Down Expand Up @@ -176,7 +188,11 @@ def center(self) -> Any:
Examples
--------
>>> import pyvista as pv
>>> data = [pv.Sphere(center=(2, 0, 0)), pv.Cube(center=(0, 2, 0)), pv.Cone()]
>>> data = [
... pv.Sphere(center=(2, 0, 0)),
... pv.Cube(center=(0, 2, 0)),
... pv.Cone(),
... ]
>>> blocks = pv.MultiBlock(data)
>>> blocks.center # doctest:+SKIP
array([1., 1., 0.])
Expand All @@ -192,7 +208,11 @@ def length(self) -> float:
Examples
--------
>>> import pyvista as pv
>>> data = [pv.Sphere(center=(2, 0, 0)), pv.Cube(center=(0, 2, 0)), pv.Cone()]
>>> data = [
... pv.Sphere(center=(2, 0, 0)),
... pv.Cube(center=(0, 2, 0)),
... pv.Cone(),
... ]
>>> blocks = pv.MultiBlock(data)
>>> blocks.length
4.3584
Expand All @@ -207,7 +227,11 @@ def n_blocks(self) -> int:
Examples
--------
>>> import pyvista as pv
>>> data = [pv.Sphere(center=(2, 0, 0)), pv.Cube(center=(0, 2, 0)), pv.Cone()]
>>> data = [
... pv.Sphere(center=(2, 0, 0)),
... pv.Cube(center=(0, 2, 0)),
... pv.Cone(),
... ]
>>> blocks = pv.MultiBlock(data)
>>> blocks.n_blocks
3
Expand All @@ -233,7 +257,11 @@ def volume(self) -> float:
Examples
--------
>>> import pyvista as pv
>>> data = [pv.Sphere(center=(2, 0, 0)), pv.Cube(center=(0, 2, 0)), pv.Cone()]
>>> data = [
... pv.Sphere(center=(2, 0, 0)),
... pv.Cube(center=(0, 2, 0)),
... pv.Cone(),
... ]
>>> blocks = pv.MultiBlock(data)
>>> blocks.volume
1.7348
Expand Down Expand Up @@ -293,7 +321,10 @@ def get_index_by_name(self, name: str) -> int:
Examples
--------
>>> import pyvista as pv
>>> data = {"cube": pv.Cube(), "sphere": pv.Sphere(center=(2, 2, 0))}
>>> data = {
... "cube": pv.Cube(),
... "sphere": pv.Sphere(center=(2, 2, 0)),
... }
>>> blocks = pv.MultiBlock(data)
>>> blocks.get_index_by_name('sphere')
1
Expand Down Expand Up @@ -354,7 +385,10 @@ def append(self, dataset: Optional[_TypeMultiBlockLeaf], name: Optional[str] = N
--------
>>> import pyvista as pv
>>> from pyvista import examples
>>> data = {"cube": pv.Cube(), "sphere": pv.Sphere(center=(2, 2, 0))}
>>> data = {
... "cube": pv.Cube(),
... "sphere": pv.Sphere(center=(2, 2, 0)),
... }
>>> blocks = pv.MultiBlock(data)
>>> blocks.append(pv.Cone())
>>> len(blocks)
Expand Down Expand Up @@ -392,9 +426,14 @@ def extend(self, datasets: Iterable[_TypeMultiBlockLeaf]) -> None:
--------
>>> import pyvista as pv
>>> from pyvista import examples
>>> data = {"cube": pv.Cube(), "sphere": pv.Sphere(center=(2, 2, 0))}
>>> data = {
... "cube": pv.Cube(),
... "sphere": pv.Sphere(center=(2, 2, 0)),
... }
>>> blocks = pv.MultiBlock(data)
>>> blocks_uniform = pv.MultiBlock({"uniform": examples.load_uniform()})
>>> blocks_uniform = pv.MultiBlock(
... {"uniform": examples.load_uniform()}
... )
>>> blocks.extend(blocks_uniform)
>>> len(blocks)
3
Expand Down Expand Up @@ -461,7 +500,10 @@ def set_block_name(self, index: int, name: Optional[str]):
Examples
--------
>>> import pyvista as pv
>>> data = {"cube": pv.Cube(), "sphere": pv.Sphere(center=(2, 2, 0))}
>>> data = {
... "cube": pv.Cube(),
... "sphere": pv.Sphere(center=(2, 2, 0)),
... }
>>> blocks = pv.MultiBlock(data)
>>> blocks.append(pv.Cone())
>>> blocks.set_block_name(2, 'cone')
Expand Down Expand Up @@ -491,7 +533,10 @@ def get_block_name(self, index: int) -> Optional[str]:
Examples
--------
>>> import pyvista as pv
>>> data = {"cube": pv.Cube(), "sphere": pv.Sphere(center=(2, 2, 0))}
>>> data = {
... "cube": pv.Cube(),
... "sphere": pv.Sphere(center=(2, 2, 0)),
... }
>>> blocks = pv.MultiBlock(data)
>>> blocks.get_block_name(0)
'cube'
Expand All @@ -514,7 +559,10 @@ def keys(self) -> List[Optional[str]]:
Examples
--------
>>> import pyvista as pv
>>> data = {"cube": pv.Cube(), "sphere": pv.Sphere(center=(2, 2, 0))}
>>> data = {
... "cube": pv.Cube(),
... "sphere": pv.Sphere(center=(2, 2, 0)),
... }
>>> blocks = pv.MultiBlock(data)
>>> blocks.keys()
['cube', 'sphere']
Expand All @@ -539,7 +587,10 @@ def replace(self, index: int, dataset: Optional[_TypeMultiBlockLeaf]) -> None:
--------
>>> import pyvista as pv
>>> import numpy as np
>>> data = {"cube": pv.Cube(), "sphere": pv.Sphere(center=(2, 2, 0))}
>>> data = {
... "cube": pv.Cube(),
... "sphere": pv.Sphere(center=(2, 2, 0)),
... }
>>> blocks = pv.MultiBlock(data)
>>> blocks.replace(1, pv.Sphere(center=(10, 10, 10)))
>>> blocks.keys()
Expand Down Expand Up @@ -704,7 +755,10 @@ def insert(self, index: int, dataset: _TypeMultiBlockLeaf, name: Optional[str] =
Insert a new :class:`pyvista.PolyData` at the start of the multiblock.
>>> import pyvista as pv
>>> data = {"cube": pv.Cube(), "sphere": pv.Sphere(center=(2, 2, 0))}
>>> data = {
... "cube": pv.Cube(),
... "sphere": pv.Sphere(center=(2, 2, 0)),
... }
>>> blocks = pv.MultiBlock(data)
>>> blocks.keys()
['cube', 'sphere']
Expand Down Expand Up @@ -742,7 +796,10 @@ def pop(self, index: Union[int, str] = -1) -> Optional[_TypeMultiBlockLeaf]:
Pop the ``"cube"`` multiblock.
>>> import pyvista as pv
>>> data = {"cube": pv.Cube(), "sphere": pv.Sphere(center=(2, 2, 0))}
>>> data = {
... "cube": pv.Cube(),
... "sphere": pv.Sphere(center=(2, 2, 0)),
... }
>>> blocks = pv.MultiBlock(data)
>>> blocks.keys()
['cube', 'sphere']
Expand All @@ -765,7 +822,10 @@ def reverse(self):
Reverse a multiblock.
>>> import pyvista as pv
>>> data = {"cube": pv.Cube(), "sphere": pv.Sphere(center=(2, 2, 0))}
>>> data = {
... "cube": pv.Cube(),
... "sphere": pv.Sphere(center=(2, 2, 0)),
... }
>>> blocks = pv.MultiBlock(data)
>>> blocks.keys()
['cube', 'sphere']
Expand Down Expand Up @@ -907,7 +967,11 @@ def copy(self, deep=True):
Examples
--------
>>> import pyvista as pv
>>> data = [pv.Sphere(center=(2, 0, 0)), pv.Cube(center=(0, 2, 0)), pv.Cone()]
>>> data = [
... pv.Sphere(center=(2, 0, 0)),
... pv.Cube(center=(0, 2, 0)),
... pv.Cone(),
... ]
>>> blocks = pv.MultiBlock(data)
>>> new_blocks = blocks.copy()
>>> len(new_blocks)
Expand Down
4 changes: 3 additions & 1 deletion pyvista/core/dataobject.py
View file
Expand Up @@ -366,7 +366,9 @@ def add_field_data(self, array: np.ndarray, name: str, deep=True):
Add field data to a UniformGrid dataset.
>>> mesh = pyvista.UniformGrid(dimensions=(2, 2, 1))
>>> mesh.add_field_data(['I could', 'write', 'notes', 'here'], 'my-field-data')
>>> mesh.add_field_data(
... ['I could', 'write', 'notes', 'here'], 'my-field-data'
... )
>>> mesh['my-field-data']
pyvista_ndarray(['I could', 'write', 'notes', 'here'], dtype='<U7')
Expand Down
11 changes: 8 additions & 3 deletions pyvista/core/dataset.py
View file
Expand Up @@ -2366,7 +2366,9 @@ def find_containing_cell(
containing the point ``[0.3, 0.3, 0.0]`` is found.
>>> import pyvista
>>> mesh = pyvista.UniformGrid(dimensions=[5, 5, 1], spacing=[1 / 4, 1 / 4, 0])
>>> mesh = pyvista.UniformGrid(
... dimensions=[5, 5, 1], spacing=[1 / 4, 1 / 4, 0]
... )
>>> mesh
UniformGrid...
>>> mesh.find_containing_cell([0.3, 0.3, 0.0])
Expand Down Expand Up @@ -2472,7 +2474,9 @@ def find_cells_within_bounds(self, bounds: Iterable[float]) -> np.ndarray:
--------
>>> import pyvista
>>> mesh = pyvista.Cube()
>>> index = mesh.find_cells_within_bounds([-2.0, 2.0, -2.0, 2.0, -2.0, 2.0])
>>> index = mesh.find_cells_within_bounds(
... [-2.0, 2.0, -2.0, 2.0, -2.0, 2.0]
... )
"""
if np.array(bounds).size != 6:
Expand Down Expand Up @@ -2573,7 +2577,8 @@ def cell(self) -> Iterator['pyvista.Cell']:
Loop over the cells
>>> import pyvista as pv
>>> mesh = pv.UniformGrid(dimensions=(3, 3, 1)) # 9 points, 4 cells
>>> # Create a grid with 9 points and 4 cells
>>> mesh = pv.UniformGrid(dimensions=(3, 3, 1))
>>> for cell in mesh.cell: # doctest: +SKIP
... cell
...
Expand Down
4 changes: 3 additions & 1 deletion pyvista/core/datasetattributes.py
View file
Expand Up @@ -1096,7 +1096,9 @@ def active_vectors_name(self) -> Optional[str]:
>>> import pyvista
>>> import numpy as np
>>> mesh = pyvista.Sphere()
>>> mesh.point_data.set_vectors(np.random.random((mesh.n_points, 3)), 'my-vectors')
>>> mesh.point_data.set_vectors(
... np.random.random((mesh.n_points, 3)), 'my-vectors'
... )
>>> mesh.point_data.active_vectors_name
'my-vectors'
Expand Down
5 changes: 4 additions & 1 deletion pyvista/core/filters/composite.py
View file
Expand Up @@ -53,7 +53,10 @@ def combine(self, merge_points=False, tolerance=0.0):
>>> import pyvista
>>> block = pyvista.MultiBlock(
... [pyvista.Cube(clean=False), pyvista.Cube(center=(1, 0, 0), clean=False)]
... [
... pyvista.Cube(clean=False),
... pyvista.Cube(center=(1, 0, 0), clean=False),
... ]
... )
>>> merged = block.combine()
>>> merged.n_points
Expand Down

0 comments on commit 635052d

Please sign in to comment.