[go: up one dir, main page]
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.

Sign up for GitHub

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

Jump to bottom

Add type hints documentation #472

Open
camilamaia opened this issue Aug 1, 2021 · 1 comment
Open

Add type hints documentation #472

camilamaia opened this issue Aug 1, 2021 · 1 comment
Labels
Wiki https://github.com/scanapi/scanapi/wiki

Comments

@camilamaia
Copy link
Member

Feature request

Description the feature

We are introducing type hints to the project: #431 and for that we need a clear documentation of:

  • How to use type hints
  • When to use type hints

Also, to make it clear this is optional:

  • "If you're not familiar with typing then just forget about it and write usual python code"
  • "If you're familiar with typing - new type annotations are very welcome"
@camilamaia camilamaia added the Wiki https://github.com/scanapi/scanapi/wiki label Aug 1, 2021
@camilamaia camilamaia mentioned this issue Aug 1, 2021
Closed
@JPTIZ JPTIZ mentioned this issue Oct 2, 2021
Closed
@taconi
Copy link
Contributor
taconi commented Nov 29, 2022

Perhaps pep 484 is good documentation on type hinting, and as the application is a CLI, it may not be necessary to inform in the project documentation how to use type annotations.
About adding the input/output types of the functions I could be doing this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Wiki https://github.com/scanapi/scanapi/wiki
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@camilamaia @taconi