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

Fix documentation error. #414

Merged
merged 1 commit into from
Feb 14, 2019
Merged

Fix documentation error. #414

merged 1 commit into from
Feb 14, 2019

Conversation

twavv
Copy link
Contributor

@twavv twavv commented Dec 18, 2018

Consider the following sequence of events for a kernel.

  • Client A sends execution request (id: R1)
  • Client B sends execution request (id: R2)
  • R1 raises an exception
  • Client A receives execute_reply with content {"status": "error", ...}
  • Client B recieves execute_reply with content {"status": "aborted"}

The documentation says that B should received abort rather than aborted, but the IPython kernel returns aborted (and is probably what it actually should be).

Additionally, the language around stop_on_error is confusing (I think the documentation has it backwards but I'm not sure).

@minrk
Copy link
Member

minrk commented Feb 14, 2019

You're absolutely right about stop_on_error being backwards. I think the original proposal was for ignore_errors which had inverted logic and the name got updated but not the description.

Would you like to send another PR for that?

@minrk minrk merged commit e206315 into jupyter:master Feb 14, 2019
@minrk minrk added this to the 5.2.5 milestone Feb 14, 2019
@twavv twavv deleted the travigd-patch-1 branch February 14, 2019 20:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants