Ticket #7002 (closed defect: fixed)
Notebook documentation says to use "#auto", but should be "%auto"
| Reported by: | jason | Owned by: | tba |
|---|---|---|---|
| Priority: | minor | Milestone: | sage-4.7.1 |
| Component: | documentation | Keywords: | |
| Cc: | mvngu, kcrisman | Work issues: | |
| Report Upstream: | N/A | Reviewers: | Karl-Dieter Crisman, Jeroen Demeyer |
| Authors: | Jason Grout | Merged in: | sage-4.7.1.alpha2 |
| Dependencies: | Stopgaps: |
Description (last modified by jdemeyer) (diff)
#auto was the old way, %auto was the new way. Plus, we should say % directives need to happen above the input.
To see the problem, click the "Help" in the upper right corner. The second row is:
Any cells with "#auto" in the input is automatically evaluated when the worksheet is first opened.
This should be changed to:
Any cells with "%auto" above the input is automatically evaluated when the worksheet is first opened.
Apply 7002_rebase_4.7.patch to sagenb.
Attachments
-
trac-7002-autoevaluate.patch
(1.8 KB) -
added by jason 4 years ago.
-
trac-7002-autoevaluate-rebase.patch
(995 bytes) -
added by kcrisman 4 years ago.
- Based on 4.1.2.alpha2
-
7002_rebase_4.7.patch
(981 bytes) -
added by jdemeyer 2 years ago.
Change History
comment:2 Changed 4 years ago by kcrisman
I hate to say this... is a deprecation period in order here? Or was #auto never the way to do it in the first place? I have to admit I was always confused by it, which probably led to very few worksheets using it in classes!
comment:3 follow-up: ↓ 5 Changed 4 years ago by jason
Probably, though I'm not sure how we would do a deprecation, since it is the notebook feature that is deprecated, not something in the Sage process doing the calculations.
"#auto" used to be the way to do things before Mike Hansen refactored things (in January or February, I believe).
What I am suggesting is just that the documentation be changed to reflect the new way. The "#auto" still works. I'd just like to get new people using "%auto".
comment:4 Changed 4 years ago by jason
- Summary changed from Notebook documentation says to use "#auto", but should be "%auto" to [with patch, needs review] Notebook documentation says to use "#auto", but should be "%auto"
comment:5 in reply to: ↑ 3 Changed 4 years ago by kcrisman
- Summary changed from [with patch, needs review] Notebook documentation says to use "#auto", but should be "%auto" to [with patch, needs work?] Notebook documentation says to use "#auto", but should be "%auto"
Replying to jason:
Probably, though I'm not sure how we would do a deprecation, since it is the notebook feature that is deprecated, not something in the Sage process doing the calculations.
"#auto" used to be the way to do things before Mike Hansen refactored things (in January or February, I believe).
What I am suggesting is just that the documentation be changed to reflect the new way. The "#auto" still works. I'd just like to get new people using "%auto".
Oh, if it still works and we aren't getting rid of it, then probably just making the change is okay.
Incidentally, this doesn't apply cleanly due to someone having added something about HTML above the Shell scripts thingie. Does this patch depend on something?
comment:6 Changed 4 years ago by jason
- Summary changed from [with patch, needs work?] Notebook documentation says to use "#auto", but should be "%auto" to [with patch, needs rebase] Notebook documentation says to use "#auto", but should be "%auto"
No, it doesn't depend on anything, but it was a patch based on the last version I have on my laptop, so something like 4.1.1 or 4.1.2.alpha1 or something.
Changed 4 years ago by kcrisman
-
attachment
trac-7002-autoevaluate-rebase.patch
added
Based on 4.1.2.alpha2
comment:7 Changed 4 years ago by kcrisman
- Reviewers set to Karl-Dieter Crisman
- Summary changed from [with patch, needs rebase] Notebook documentation says to use "#auto", but should be "%auto" to [with patch, positive review] Notebook documentation says to use "#auto", but should be "%auto"
- Authors set to Jason Grout
Positive review, since I just tested that %auto still works (as well as #auto); apply rebase patch only.
comment:8 Changed 4 years ago by mvngu
- Status changed from new to closed
- Resolution set to fixed
- Merged in set to Sage 4.1.2.alpha3
comment:10 Changed 4 years ago by mvngu
- Merged in changed from Sage 4.1.2.alpha3 to Sage 4.1.2.alpha4
There is no 4.1.2.alpha3. Sage 4.1.2.alpha3 was William Stein's release for working on making the notebook a standalone package.
comment:11 follow-up: ↓ 13 Changed 2 years ago by jason
- Report Upstream set to N/A
I just checked the help in 4.6.2 and it appears that these changes do *not* appear in the help text.
comment:12 Changed 2 years ago by jdemeyer
- Reviewers changed from Karl-Dieter Crisman to Karl-Dieter Crisman, Jeroen Demeyer
- Summary changed from [with patch, positive review] Notebook documentation says to use "#auto", but should be "%auto" to Notebook documentation says to use "#auto", but should be "%auto"
- Description modified (diff)
- Merged in changed from Sage 4.1.2.alpha4 to sage-4.7.1.alpha2
- Milestone changed from sage-4.1.2 to sage-4.7.1
comment:13 in reply to: ↑ 11 ; follow-up: ↓ 14 Changed 2 years ago by kcrisman
Replying to jason:
I just checked the help in 4.6.2 and it appears that these changes do *not* appear in the help text.
Correct. Thanks for checking on this also, Jeroen.
I do remember that there is a different ticket open for "really" doing this, isn't there? Unfortunately I just came back on the grid for the first time in a week so I don't have time to search for it.
comment:14 in reply to: ↑ 13 Changed 2 years ago by kcrisman
Replying to kcrisman:
Replying to jason:
I just checked the help in 4.6.2 and it appears that these changes do *not* appear in the help text.
Correct. Thanks for checking on this also, Jeroen.
I do remember that there is a different ticket open for "really" doing this, isn't there? Unfortunately I just came back on the grid for the first time in a week so I don't have time to search for it.
It's #8956, apparently. I've requested that one be closed, since the issue is dealt with here.
