Various improvements to the documentation including additional type hints and fixes to the formatting of the docstrings of the class PadeDFT and the functions get_array and get_dft_array. Also, there were several instances where the type hint Optional had to be removed because it was being used incorrectly. The correct usage of Optional is described in https://docs.python.org/3/library/typing.html#typing.Optional:
An optional argument with a default does not require the `Optional` qualifier on its type
annotation just because it is optional … if an explicit value of `None` is allowed, the use
of `Optional` is appropriate, whether the argument is optional or not.
Once the readthedocs build failure is fixed, a separate PR will be created for regenerating the markdown pages of the user manual from the docstrings to include these changes.
Various improvements to the documentation including additional type hints and fixes to the formatting of the docstrings of the class
PadeDFTand the functionsget_arrayandget_dft_array. Also, there were several instances where the type hintOptionalhad to be removed because it was being used incorrectly. The correct usage ofOptionalis described in https://docs.python.org/3/library/typing.html#typing.Optional:Once the readthedocs build failure is fixed, a separate PR will be created for regenerating the markdown pages of the user manual from the docstrings to include these changes.