clarified sequence and iterable argument types

This commit is contained in:
Philip Eisenlohr 2022-05-18 09:21:32 -04:00
parent 0962d2ebdf
commit 254524fa38
2 changed files with 8 additions and 8 deletions

View File

@ -1,6 +1,6 @@
import re import re
import copy import copy
from typing import Union, Tuple, List from typing import Union, Tuple, List, Iterable
import pandas as pd import pandas as pd
import numpy as np import numpy as np
@ -14,7 +14,7 @@ class Table:
def __init__(self, def __init__(self,
shapes: dict, shapes: dict,
data: np.ndarray, data: np.ndarray,
comments: Union[str, list] = None): comments: Union[str, Iterable] = None):
""" """
New spreadsheet. New spreadsheet.
@ -434,8 +434,8 @@ class Table:
def rename(self, def rename(self,
old: Union[str, List[str]], old: Union[str, Iterable[str]],
new: Union[str, List[str]], new: Union[str, Iterable[str]],
info: str = None) -> 'Table': info: str = None) -> 'Table':
""" """
Rename column data. Rename column data.

View File

@ -153,11 +153,11 @@ class VTK:
Parameters Parameters
---------- ----------
cells : iterable of int, len (3) cells : sequence of int, len (3)
Number of cells along each dimension. Number of cells along each dimension.
size : iterable of float, len (3) size : sequence of float, len (3)
Physical length along each dimension. Physical length along each dimension.
origin : iterable of float, len (3), optional origin : sequence of float, len (3), optional
Coordinates of grid origin. Coordinates of grid origin.
Returns Returns
@ -257,7 +257,7 @@ class VTK:
Parameters Parameters
---------- ----------
grid : iterables of floats, len (3) grid : sequence of floats, len (3)
Grid coordinates along x, y, and z directions. Grid coordinates along x, y, and z directions.
Returns Returns