Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Type annotation error with Python 3.8 #9

Closed
AnesBenmerzoug opened this issue Apr 8, 2024 · 1 comment · Fixed by #10
Closed

Type annotation error with Python 3.8 #9

AnesBenmerzoug opened this issue Apr 8, 2024 · 1 comment · Fixed by #10
Assignees
Labels
bug Something isn't working

Comments

@AnesBenmerzoug
Copy link

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
Copy link
Owner

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!

@EddyLuten EddyLuten self-assigned this Apr 8, 2024
@EddyLuten EddyLuten added the bug Something isn't working label Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants