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

Minor addition to docs #529

Merged
merged 1 commit into from
Aug 12, 2019
Merged

Minor addition to docs #529

merged 1 commit into from
Aug 12, 2019

Conversation

krinsman
Copy link
Contributor

@krinsman krinsman commented Aug 9, 2019

Suggested minor addition to the docs to prevent other people from making the same mistake I made.

I know this is fairly obvious in hindsight, but better explicit than implicit I guess. I genuinely did spend around 30-60 minutes puzzled about how to fix this (since I had assumed incorrectly that the default behavior was that the value of proposal.value was accepted automatically as long as no errors were raised by the decorating function, but really functions with @validate decorators seem to be setters as much as anything else).

Again, my fault for not reading the original docs closely enough. I thought it might be helpful to explain the examples a little bit, is all.

@krinsman
Copy link
Contributor Author

krinsman commented Aug 9, 2019

As far as I can tell the reason why this fails one of the Travis tests doesn't relate to the changes I made, since I made no changes to the code, just to the docs, but the failed Travis test was because of one of the lines of code.

@rmorshea
Copy link
Contributor

Yeah, this isn't you. A downstream project is failing.

@rmorshea rmorshea merged commit 41551bc into ipython:master Aug 12, 2019
@rmorshea
Copy link
Contributor

rmorshea commented Aug 12, 2019

BTW just added #530 to track a 4.3.x release.

@Carreau Carreau added this to the 5.0 milestone Jun 4, 2020
@Carreau Carreau added 5.0-re-review Need to re-review for potential API impact changes. 5.0-no-incidence change that has noincidence on 5.0 compat (eg: doc) and removed 5.0-re-review Need to re-review for potential API impact changes. labels Jun 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5.0-no-incidence change that has noincidence on 5.0 compat (eg: doc)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants