[x] This PR addresses an already opened issue (for bug fixes / features)
No.
[x] (If applicable) Documentation has been added / updated (for bug fixes / features).
[x] (If applicable) Tests have been added.
[x] This PR does not seem to break the templates.
[x] HISTORY.rst has been updated (with summary of main changes).
[x] Link to issue (:issue:number) and pull request (:pull:number) has been added.
What kind of change does this PR introduce?
Removed a few outdated imports.
Typing was added to multiple functions when it was missing.
Output types were added to multiple functions when it was missing.
Docstrings was added to multiple functions when it was missing.
Both str and os.PathLike should be explicitly supported where relevant.
Minor bugfixes when I saw them.
Module descriptions were added when missing.
To make things readable:
As much as possible, the type of data in lists was defined.
The type of data in dictionaries was not.
Does this PR introduce a breaking change?
It should not.
Other information:
Pycharm recommended that I add ABC to DataCatalog/ProjectCatalog. It this right? @aulemahal
The init and documentation of DataCatalog/ProjectCatalog should be reworked to be easier to understand, but this is out-of-scope for this PR. For example we use *args, but AFAIK there is only one possible input argument, obj.
Pull Request Checklist:
number
) and pull request (:pull:number
) has been added.What kind of change does this PR introduce?
str
andos.PathLike
should be explicitly supported where relevant.Does this PR introduce a breaking change?
Other information:
ABC
toDataCatalog/ProjectCatalog
. It this right? @aulemahalinit
and documentation ofDataCatalog/ProjectCatalog
should be reworked to be easier to understand, but this is out-of-scope for this PR. For example we use*args
, but AFAIK there is only one possible input argument,obj
.