Skip to content

Suggestion: Add type annotations and docstrings/comments to python roadmap #10119

Description

@nerrader

Roadmap URL

https://roadmap.sh/python

Suggestions

I think type annotations/type hinting and comments/docstrings should be explicitly shown in the roadmap somewhere.

Type annotations are pretty much crucial in most codebases due to the addition of static type checkers, which catches errors before they even happen, and it's a good habit for a beginner to start using type annotations as soon as possible.

Comments and docstrings should be taught (as well as how to use them effectively) as they can like you know improve readability of code. I think its just a fundamental thing that should be taught here. Maybe you can also make a reference to the autoDocstring extension in VSCode as a way to help make better docstrings.

Maybe you could also add an introduction to PEP8 guidelines as well somewhere, but I don't think its that critical compared to the other two suggestions here.

Metadata

Metadata

Assignees

No one assigned

    Labels

    pythonRoadmap: pythontopic-changeMissing or deprecated topics in roadmap

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions