ReferenceΒΆ

Every function is documented once, in the TSDoc comments of the TypeScript sources. The TypeScript reference is generated from them by TypeDoc; the docstrings of the Python package are written from them by fixed rules (names in snake_case, an options object as keyword arguments, RangeError as SymcrysError) and add only what Python alone has, the shapes and types of the NumPy arrays.