Opened 2 years ago

Closed 2 years ago

#27796 closed enhancement (fixed)

get rid of dollar signs in elliptic curves

Reported by: chapoton Owned by:
Priority: major Milestone: sage-8.8
Component: documentation Keywords:
Cc: Merged in:
Authors: Frédéric Chapoton Reviewers: Travis Scrimshaw
Report Upstream: N/A Work issues:
Branch: dd71d87 (Commits, GitHub, GitLab) Commit: dd71d87233726b26bc10c1fa5e8694b1c394d7c2
Dependencies: Stopgaps:

Status badges

Description


Change History (8)

comment:1 Changed 2 years ago by chapoton

  • Branch set to u/chapoton/27796
  • Commit set to dd71d87233726b26bc10c1fa5e8694b1c394d7c2
  • Status changed from new to needs_review

New commits:

dd71d87get rid of dollars in elliptic curves

comment:2 Changed 2 years ago by jhpalmieri

Is there a reason for this? Dollar signs should work just as well as backticks in docstrings, for triggering math mode.

comment:3 Changed 2 years ago by chapoton

Just for the sake of uniformity of documentation, no more serious reason. Most of the existing $ are remainders of the first few years of sage.

comment:4 follow-up: Changed 2 years ago by tscrim

  • Reviewers set to Travis Scrimshaw
  • Status changed from needs_review to positive_review

I think this is useful to do as people will look to random bits of doc, see this, and then argue that they can do it because it was done elsewhere.

comment:5 in reply to: ↑ 4 ; follow-up: Changed 2 years ago by jhpalmieri

Replying to tscrim:

I think this is useful to do as people will look to random bits of doc, see this, and then argue that they can do it because it was done elsewhere.

The implication here is that dollar signs are bad; is that what you intend? Dollar signs are explicitly allowed according to our documentation, and people who are used to LaTeX will be comfortable using them. I see no reason to discourage their use.

comment:6 in reply to: ↑ 5 Changed 2 years ago by tscrim

Replying to jhpalmieri:

Replying to tscrim:

I think this is useful to do as people will look to random bits of doc, see this, and then argue that they can do it because it was done elsewhere.

The implication here is that dollar signs are bad; is that what you intend? Dollar signs are explicitly allowed according to our documentation, and people who are used to LaTeX will be comfortable using them. I see no reason to discourage their use.

My understanding is the dollar signs were (strongly) discouraged and the documentation used to reflect this. Although apparently that is not the case and/or has changed. We also (much) more uniformly have backticks throughout the codebase, so there is that too.

comment:7 Changed 2 years ago by jhpalmieri

I've never had that understanding. Note that I wrote the original process_dollars function to make the transition to Sphinx easier, and that was about 10 years ago.

Anyway, I don't object to the change on this ticket, but I don't think it should be a routine thing. It's sort of like deciding that we don't want to use a as a variable name anywhere, and so going through changing every a to b.

comment:8 Changed 2 years ago by vbraun

  • Branch changed from u/chapoton/27796 to dd71d87233726b26bc10c1fa5e8694b1c394d7c2
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.