#17745: typo causes latex error in indexed generators
-------------------------------------+-------------------------------------
       Reporter:  kcrisman           |        Owner:
           Type:  defect             |       Status:  needs_review
       Priority:  minor              |    Milestone:  sage-6.5
      Component:  documentation      |   Resolution:
       Keywords:                     |    Merged in:
        Authors:  John Palmieri      |    Reviewers:  Travis Scrimshaw
Report Upstream:  N/A                |  Work issues:
         Branch:                     |       Commit:
  u/jhpalmieri/typo_causes_latex_error_in_indexed_generators|  
18c6a2771996c623276e9cc362c9eecda69e4c4e
   Dependencies:                     |     Stopgaps:
-------------------------------------+-------------------------------------

Comment (by jhpalmieri):

 Replying to [comment:19 aapitzsch]:
 > The current implementation replaces LaTeX commands in the examples
 section, too.

 I think that's complicated to fix. We would need to detect when we're in
 an EXAMPLES or TESTS block and ignore the output, but otherwise process
 the output. I guess we can do that, but it's a little annoying to do
 perfectly. This really should be done for each of `detex`,
 `process_dollars`, `process_extlinks`, `process_mathtt`. So maybe it
 should actually be done in `format`:
 {{{
 if not in examples block:
     detex(next line)
     process_dollars(next_lines)
     ...
 }}}
 So everything would need to be rewritten with this logic in mind.
 Alternatively, each of those functions will duplicate some code which
 keeps track of whether it's processing a line in an examples block.

 I think that really, functions which have LaTeX output in their EXAMPLES
 (or elsewhere in their docstrings), and if that LaTeX should not be
 processed, then they should have their docstrings decorated with
 `nodetex`. That's why `nodetex` is available. Maybe we should add it to
 the !IndexedGenerators docstring.

 > P.S. The ticket description should be updated.

 Please go ahead. What did you have in mind?

--
Ticket URL: <http://trac.sagemath.org/ticket/17745#comment:20>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica, 
and MATLAB

-- 
You received this message because you are subscribed to the Google Groups 
"sage-trac" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.

Reply via email to