Typing

[not-my-profile]

• The first commit improves the API of BaseRenderer so it's easier to understand.
• The second commit adds more type hints which improves the robustness of the code base (allowing static type checkers like mypy or Pyright to check that the types are used correctly).

If you like these changes, please merge them without squashing. If you have any questions, I'm happy to answer them.

[pbodnar]

Hi @not-my-profile, thanks for your PR, it looks promising. Could you please split it to 2 separate PRs though? 1 for the refactoring stuff and (possibly later, after the 1st gets merged) 1 for the feature extension of HTMLRenderer? So that it is easier to focus discussion around them. I would have some questions and suggestions before doing a merge, so that we can cover all those "tiny details" which in my opinion are important though...

Or, as I can imagine there would be quite an overhead of Git branching etc. in this case, we could try to discuss it all-in-one here if you want to.

[not-my-profile]

No worries I dropped the third commit from this PR. I'll open a new PR for it once this one is merged.

[pbodnar]

typing: Add type hints for HTMLRenderer methods

Once we tune this, we should better apply this to all other renderers to have some consistency, right? That will be quite a job... :)

[pbodnar]

Thank you!