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

Revise src/doc/en/tutorial/interactive_shell.rst #22934

Open
sagetrac-maskray mannequin opened this issue May 3, 2017 · 8 comments
Open

Revise src/doc/en/tutorial/interactive_shell.rst #22934

sagetrac-maskray mannequin opened this issue May 3, 2017 · 8 comments

Comments

@sagetrac-maskray
Copy link
Mannequin

sagetrac-maskray mannequin commented May 3, 2017

Revise the outdated commands and output.

Component: documentation

Author: maskray

Branch/Commit: u/maskray/doc-tutorial @ 9cba06c

Issue created by migration from https://trac.sagemath.org/ticket/22934

@sagetrac-maskray sagetrac-maskray mannequin added this to the sage-8.0 milestone May 3, 2017
@sagetrac-maskray
Copy link
Mannequin Author

sagetrac-maskray mannequin commented May 6, 2017

Reviewer: Travis Scrimshaw

@kcrisman
Copy link
Member

kcrisman commented Jul 7, 2017

comment:4

I didn't see this before I did my own revisions which are now in the 8.0rc series (related to the Jupyter notebook becoming semi-default). So no longer applies to develop. However, most of this is still quite useful - especially if done in all translations of the tutorials.

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jul 8, 2017

Changed commit from e535d39 to 9cba06c

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jul 8, 2017

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

9cba06cRevise src/doc/en/tutorial/interactive_shell.rst

@sagetrac-maskray
Copy link
Mannequin Author

sagetrac-maskray mannequin commented Jul 8, 2017

comment:6

Rebased on develop (Date: Wed Jul 5 23:42:05 2017 +0200)

@bryangingechen
Copy link
Mannequin

bryangingechen mannequin commented Jul 28, 2018

comment:7

There are 3 failing doctests in src/doc/en/tutorial/interactive_shell.rst related to BackgroundJobManager.

Currently, that part of the documentation describes an IPython magic command %bg which no longer exists. The examples currently there are all marked as # not tested.

I'm not sure whether it makes sense to keep your update of this section since now it is about using IPython.lib.backgroundjobs.BackgroundJobManager and thus feels a bit out of place in a section focused on IPython magic commands.

If you (or others) feel strongly about keeping this section, then you could simply add .. skip before the blocks of code there to keep them out of the tests, since the code they are replacing is not being tested anyways.

Also note that you should put your real name in the "Authors:" field of this ticket.

@bryangingechen
Copy link
Mannequin

bryangingechen mannequin commented Jul 28, 2018

Changed reviewer from Travis Scrimshaw to none

@bryangingechen bryangingechen mannequin modified the milestones: sage-8.0, sage-8.4 Jul 28, 2018
@mkoeppe mkoeppe removed this from the sage-8.4 milestone Dec 29, 2022
@jhpalmieri
Copy link
Member

I created #35836 to remove %bg from the tutorial (addressing at least part of #22934 (comment)).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants