Opened 6 years ago

Closed 7 weeks ago

#18406 closed defect (fixed)

Fix times in graphics doc

Reported by: kcrisman Owned by:
Priority: trivial Milestone: sage-9.3
Component: documentation Keywords:
Cc: kcrisman, slelievre Merged in:
Authors: Samuel Lelièvre Reviewers: Karl-Dieter Crisman
Report Upstream: N/A Work issues:
Branch: f259041 (Commits) Commit: f259041bf50f6b184fc1689befe65594564df2f8
Dependencies: Stopgaps:

Description (last modified by slelievre)

The docstring for show is raw (r""" ... """) and contains

`[0,1]\\times[0,1]`

which does not render right in the show documentation.

In a raw string, \\times becomes \\ (newline) + times.

The fix is to use \times instead of \\times.

Change History (7)

comment:1 Changed 2 months ago by slelievre

  • Authors set to Samuel Lelièvre
  • Branch set to public/18406
  • Cc slelievre added
  • Commit set to f259041bf50f6b184fc1689befe65594564df2f8
  • Description modified (diff)

Here is a fix. Please review.


New commits:

f259041t-18406: Unescape backslash in raw docstring of Graphics

comment:2 Changed 2 months ago by slelievre

  • Status changed from new to needs_review

comment:3 Changed 2 months ago by slelievre

  • Cc kcrisman added
  • Milestone changed from sage-6.7 to sage-9.3

comment:4 Changed 2 months ago by kcrisman

I think I just reported this without even looking at the code - that would surely do it. Shall I trust that you verified in both html and pdf?

comment:5 Changed 2 months ago by slelievre

Ran make and make doc-pdf successfully.

Checked both html and pdf; that instance of [0,1]\times[0,1] now renders fine in both.

Found no other similar problem needing fixing.

comment:6 Changed 2 months ago by kcrisman

  • Reviewers set to Karl-Dieter Crisman
  • Status changed from needs_review to positive_review

Thanks for this!

comment:7 Changed 7 weeks ago by vbraun

  • Branch changed from public/18406 to f259041bf50f6b184fc1689befe65594564df2f8
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.