Opened 10 years ago

Closed 7 years ago

#11907 closed defect (fixed)

Modify tutorials: no more 'examples' directory

Reported by: jhpalmieri Owned by: mvngu
Priority: major Milestone: sage-6.2
Component: documentation Keywords:
Cc: leif Merged in:
Authors: Ralf Stephan Reviewers: John Palmieri
Report Upstream: N/A Work issues:
Branch: 011f0b9 (Commits, GitHub, GitLab) Commit: 011f0b9dd12e3b2b46c6750eaac57eb6b10f2814
Dependencies: Stopgaps:

Status badges


All of the versions of the tutorial (en, fr, de, ru) reference a file in the directory SAGE_ROOT/examples. Since this directory is being removed (see #7494), this part of the tutorial needs to be rewritten. Is the referenced file (factorial.spyx) outdated, or is it worth keeping? If worth keeping, the easiest thing to do would be to move it somewhere else. Where?

(By the way, if the file is worth keeping, the doctests don't work: they give syntax errors. I don't think you can doctest using the "time" command. So they should perhaps be marked as # not tested. Also, the "TODO" note seems outdated and should probably be removed.)

Change History (11)

comment:1 Changed 10 years ago by leif

  • Cc leif added

How about moving a cleaned-up version to data/extcode/ if we really need it?

Looks pretty outdated btw. Do we really need an example file, or could we just include parts of it inline into the documentation?

comment:2 follow-up: Changed 10 years ago by leif

Tagging the sage: time n = ... examples "# not tested" solves the problem.

("# random" wouldn't work, since that does execute the code, but [%]time is an IPython feature. Feel free to change the doctest framework to run some files with ipython, e.g. in case they contain such directives... ;P )

Or instead use sage: timeit("...") # random runtime, but that looks ugly for an example, and of course takes longer.

comment:3 in reply to: ↑ 2 Changed 10 years ago by jhpalmieri

Replying to leif:

Feel free to change the doctest framework to run some files with ipython, e.g. in case they contain such directives... ;P )

Oh, right, just give me 5 minutes. :P

comment:4 Changed 10 years ago by jhpalmieri

By the way, I'm not competent enough in Cython, French, German, or Russian to deal with most of the issues here. Others will have to come up with the patches.

comment:5 Changed 8 years ago by jdemeyer

  • Milestone changed from sage-5.11 to sage-5.12

comment:6 Changed 7 years ago by vbraun_spam

  • Milestone changed from sage-6.1 to sage-6.2

comment:7 Changed 7 years ago by rws

  • Branch set to u/rws/ticket/11907
  • Modified changed from 01/30/14 21:20:52 to 01/30/14 21:20:52

comment:8 Changed 7 years ago by rws

  • Authors set to Ralf Stephan
  • Commit set to 011f0b9dd12e3b2b46c6750eaac57eb6b10f2814
  • Status changed from new to needs_review

The TODO note/file(?) is no longer there, as well as the example dir with the file, so I simply removed the relevant sentences in all languages. These were (IMHO, I'm natural German, fluent in en, and can read fr) all the same, this is easily seen.

New commits:

011f0b9Trac #11907: remove reference to no longer existing file

comment:9 Changed 7 years ago by jhpalmieri

  • Reviewers set to John Palmieri
  • Status changed from needs_review to positive_review

Looks okay to me.

comment:10 Changed 7 years ago by vbraun

  • Priority changed from critical to major

comment:11 Changed 7 years ago by vbraun

  • Branch changed from u/rws/ticket/11907 to 011f0b9dd12e3b2b46c6750eaac57eb6b10f2814
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.