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

Types in return statements #791

Open
mauicv opened this issue May 18, 2023 · 1 comment
Open

Types in return statements #791

mauicv opened this issue May 18, 2023 · 1 comment
Labels
Effort: L Priority: Low Type: Enhancement A better way of doing things

Comments

@mauicv
Copy link
Collaborator

mauicv commented May 18, 2023

As per our CONTRIBUTING.md we say:

Returning an object which contains multiple attributes and each attribute is described individually. In this case the attribute name is written between single back-ticks and the type, if provided, would be written in double back-ticks.

The language here makes it optional and we currently don't typically add types for return values that are contained in dicts, instead just opting to describe them. We should update this across the code base to be more specific. This would also mean updating the language here to make it clear that this isn't optional.
@mauicv mauicv added Priority: Low Type: Enhancement A better way of doing things Effort: L labels May 18, 2023
@mauicv mauicv mentioned this issue May 18, 2023
Merged
2 tasks
@LakshmanKishore
Copy link
Contributor

Hi @mauicv
I would like to take up this issue!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Effort: L Priority: Low Type: Enhancement A better way of doing things
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mauicv @LakshmanKishore