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

Document types of Object properties #1675

Closed
1 task done
Tracked by #1684
Naramsim opened this issue Mar 29, 2021 · 1 comment
Closed
1 task done
Tracked by #1684

Document types of Object properties #1675

Naramsim opened this issue Mar 29, 2021 · 1 comment
Labels
documentation The issue will improve the docs

Comments

@Naramsim
Copy link

What problem are you trying to solve?

Understanding better the docs

Describe the feature

Document the types of properties inside an Object.

Take the retry example. In the docs you state that an Object has to be passed. But you don't specify the types of the statusCodes property (which should be a list) and all the other properties.

...

Checklist

  • I have read the documentation and made sure this feature doesn't already exist.

Thanks for the amazing work.

@szmarczak szmarczak added the documentation The issue will improve the docs label Mar 29, 2021
@szmarczak szmarczak mentioned this issue Apr 11, 2021
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation The issue will improve the docs
Projects
None yet
Development

No branches or pull requests

2 participants