-
Notifications
You must be signed in to change notification settings - Fork 49
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
Allow dimension-checking of multiple return values #435
Conversation
This seems like a good idea ! I don't have time to review in detail right now but I'll be back very shortly. In the mean time, I suggest updating this decorator's documentation to reflect the new possibility. Thanks for your work ! |
Thanks for taking a look.
I think I've done this already - is there anywhere else that you would suggest changing? |
You've updated the docstring (that's great !), but I'm talking about the narrative documentation. Namely, I'd expect some update to |
Thank you for following through ! automated testing seems to have caught some syntax error in the docs. I suggest you try to run |
Sorry for this CI spam - I've struggled to get all of the tests running locally. Hopefully this is the last time..! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great ! thank you so much for working on this and adding tests ! I found a subtle way your change can break backward compatibility for some users, and provided some indications on how to avoid that. Don't hesitate if you have any questions about that
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome job ! The only missing part I can think of would be a couple tests that the deprecated API behaves as expected, but I've tested it manually and I'd be okay to take the PR as is and add the tests later. I'll defer merging for a week or two so as to give other maintainers a chance to weigh in.
I believe those tests are here. Is there anything else you're looking for? Thanks for your patience with this! |
Oh I somehow missed them, even better ! I have no further request. |
Extend the
@returns
decorator so it can handle functions with multiple return values.Example:
I think I've followed everything in CONTRIBUTING, but please let me know if I've missed anything.