96 add type hints to code and updated mkdocstrings config #330
Conversation
Sara-Jade-O
changed the title
There was a problem hiding this comment.
Nice work Sara-Jade, a couple of issues I've noticed with the unit tests failing. It looks like the default arguments have been changed and are not the correct type anymore. I've highlighted a couple but might be more.
Also you will need to run the pre-commit hooks by either doing pre-commit install which means they run when attempting to commit, or to check all files do pre-commit run --all-files and this should format everything for you :)
| theme: Optional["Theme"] = None, | ||
| cover: Optional["Cover"] = None, | ||
| contentsheet_label: str = "Contents", | ||
| contentsheet_options: Optional[Dict[str, Any]] = None, |
There was a problem hiding this comment.
default argument has been changed from empty dict to None, this caused fails in unit tests
| contentsheet_options: Optional[Dict[str, Any]] = None, | ||
| notes_table: Optional[pd.DataFrame] = None, | ||
| notesheet_label: str = "Notes", | ||
| notesheet_options: Optional[Dict[str, Any]] = None, |
| legend: Optional[List[Any]] = None, | ||
| index_columns: Optional[Dict[int, int]] = None, | ||
| additional_formatting: Optional[List[Dict[str, Any]]] = None, | ||
| ) -> None: |
There was a problem hiding this comment.
Default args for subtitles, legend, index column and additional formatting have been updated which might be causing test failures
Proposed Changes
Related Issues
Pre-requisites
This section may not be fully required if the branch is not merging into main.
Please indicate items that aren't necessary and why, with comments around incomplete checks.
been made for it/them.