arviz-base/docstub.toml at main · arviz-devs/arviz-base · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
[tool.docstub.type_prefixes]
numbers = "numbers"
xarray = "xarray"
pandas = "pandas"
numpyro = "numpyro"
emcee = "emcee"
cmdstanpy = "cmdstanpy"
stan = "stan"
types = "types"

# Specify human-friendly aliases that can be used instead of Python-parsable
# annotations.
[tool.docstub.type_nicknames]
sequence = "Sequence"
iterable = "Iterable"
mapping = "Mapping"
hashable = "Hashable"
hashable_key = "Any"
iterator = "Iterator"
module = "types.ModuleType"
callable = "Callable"
labeller = "arviz_base.labels.Labeller"
Dataset = "xarray.Dataset"
DataTree = "xarray.DataTree"
# TODO: define a meta/pseudo type for DataTree-like
DataTree-like = "xarray.DataTree"
DataArray = "xarray.DataArray"
scalar = "numbers.Number"
any = "Any"