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

added links to several typing-related PEPs #37

Merged
merged 3 commits into from May 19, 2020

Conversation

ramalho
Copy link
Contributor

@ramalho ramalho commented May 18, 2020

This PR adds links to 11 additional PEPs related to type hints in Python.

I also changed the description of the previous links to the actual titles of the PEPs, which will make this list easier to maintain as new PEPs are added.

Finally, I included an asterisk (*) and an explanation about PEPs that may be more important for people getting started, as they are specifically mentioned in the first paragraph of the typing module documenation.

Copy link
Member

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for you work!

Could you please address my comment?

README.md Outdated
- [PEP-612](https://www.python.org/dev/peps/pep-0612/) - Parameter Specification Variables
- [PEP-613](https://www.python.org/dev/peps/pep-0613/) - Explicit Type Aliases

(*) these PEPs are mentioned on the first paragraph of the [typing](https://docs.python.org/3/library/typing.html) module documenation, so they may be the best places to start.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would say it is safe to remove this mark.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I will remove it.

@sobolevn
Copy link
Member

There's also a failing CI, can you please fix it?

@ramalho ramalho marked this pull request as draft May 18, 2020 22:14
@ramalho
Copy link
Contributor Author

ramalho commented May 18, 2020

I've removed the (*) as you requested.

There's also a failing CI, can you please fix it?

The CI doesn't tell me what's the problem, and I see nothing wrong in my fork rendered by Github: https://github.com/ramalho/awesome-python-typing#peps

Thanks for any help addressing the CI issue.

@ramalho ramalho marked this pull request as ready for review May 18, 2020 22:18
@sobolevn
Copy link
Member

Oh, I see. The error message is not clear indeed.

There are two problems:

  1. You are not using . to end the list item description and our linter requires that
  2. (unrelated) https://github.com/lyft/pynamodb-mypy link is dead, can you please also remove it?

Big thanks! 👍

@ramalho
Copy link
Contributor Author

ramalho commented May 19, 2020 via email

@sobolevn
Copy link
Member

Please tell me the messages appear.

Yes, the do! Thanks a lot for your help!

Copy link
Member

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉

@sobolevn sobolevn merged commit 51a8e6b into typeddjango:master May 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants