Type annotation error with Python 3.8 - Githubissues

EddyLuten / mkdocs-alias-plugin

An MkDocs plugin allowing links to your pages using a custom alias

MIT License

12 stars 2 forks source link

Type annotation error with Python 3.8 #9

Closed AnesBenmerzoug closed 5 months ago

AnesBenmerzoug commented 5 months ago

With the recent release of version 0.8.0 of mkdocs-alias, we started having errors when building our documentation using Python 3.8 (See these CI logs).

It seems that the package's code started using list for annotating lists of objects instead of using List from the typing package and that is not supported in Python 3.8.

There are 2 possible solutions:

Add from __future__ import annotations at the top of the plugin module.
Use List from the typing package instead of list until Python 3.8 is no longer supported.

EddyLuten commented 5 months ago

Hi Anes, thanks for the bug fix! I've merged it, and it will go out in version 0.8.1. I agree with your comment on the PR. I will implement CI checks for all the Python versions that MkDocs still supports.

Thanks again!