Opened 4 years ago

Last modified 4 months ago

#24367 new defect

Confusing documentation on MathJax in light of use in Jupyter notebook

Reported by: embray Owned by:
Priority: major Milestone: sage-9.4
Component: documentation Keywords: sd111
Cc: slelievre, klee Merged in:
Authors: Reviewers:
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description

As pointed out to me in this issue, this documentation page is a little confusing as to how use of the MathJax class relates to displaying LaTeX representations in the Jupyter notebook.

This confusion is increased by the fact that Jupyter doesn't display objects' latex repr by default (I'm not sure if that's the case or not for the classic Sage NB to which these docs were likely written). The user was confused into believing that the repr of a MathJax object should actually be rendered, and not display the raw HTML.

This section should probably be rewritten since it's confusing usage instructions with implementation details that won't be interesting to a casual user. I think these examples of using the MathJax class should be removed and/or moved to the class's API documentation (which could perhaps be linked to, but not further discussed?)

Change History (8)

comment:1 Changed 3 years ago by embray

  • Milestone changed from sage-8.2 to sage-8.3

comment:2 Changed 3 years ago by embray

  • Milestone changed from sage-8.3 to sage-8.4

comment:3 Changed 3 years ago by embray

  • Milestone changed from sage-8.4 to sage-8.5

comment:4 Changed 3 years ago by embray

  • Milestone changed from sage-8.5 to sage-8.7

Retargeting some of my tickets (somewhat optimistically for now).

comment:5 Changed 2 years ago by embray

  • Milestone changed from sage-8.7 to sage-pending

Removing most of the rest of my open tickets out of the 8.7 milestone, which should be closed.

comment:6 Changed 8 months ago by mkoeppe

  • Cc slelievre added
  • Keywords sd111 added
  • Milestone changed from sage-pending to sage-9.3
  • Priority changed from minor to major

comment:7 Changed 5 months ago by mkoeppe

  • Cc klee added

comment:8 Changed 4 months ago by mkoeppe

  • Milestone changed from sage-9.3 to sage-9.4
Note: See TracTickets for help on using tickets.