Opened 3 years ago

Closed 3 years ago

#19901 closed enhancement (fixed)

Index of Permutation Group methods

Reported by: ncohen Owned by:
Priority: major Milestone: sage-7.0
Component: group theory Keywords:
Cc: jmantysalo Merged in:
Authors: Nathann Cohen Reviewers: Jori Mäntysalo
Report Upstream: N/A Work issues:
Branch: 0750c2f (Commits) Commit: 0750c2f8580a84f313d253dd8fd41df0eb2871c9
Dependencies: Stopgaps:

Description

As the title says. Makes the reference manual a bit more user-friendly.

Change History (7)

comment:1 Changed 3 years ago by ncohen

  • Branch set to public/19901
  • Status changed from new to needs_review

comment:2 Changed 3 years ago by git

  • Commit set to 0750c2f8580a84f313d253dd8fd41df0eb2871c9

Branch pushed to git repo; I updated commit sha1. New commits:

0750c2ftrac #19901: Index of Permutation Group methods

comment:3 follow-up: Changed 3 years ago by jmantysalo

  • Reviewers set to Jori Mäntysalo
  • Status changed from needs_review to positive_review

Seems good, and Sage is better with this than without. Hence set to positive_review.

However, there are some dollar signs used at docstrings. I have been said that I should use backstick. As you don't introduce new dollar signs, this patch can't make things any worse. I don't remember the rationale behind dollar-backstick -difference.

(Also "computes" and "returns" should be "return", but that's a place for a new ticket, I think.)

comment:4 in reply to: ↑ 3 ; follow-up: Changed 3 years ago by ncohen

Seems good, and Sage is better with this than without. Hence set to positive_review.

Thanks!

However, there are some dollar signs used at docstrings. I have been said that I should use backstick. As you don't introduce new dollar signs, this patch can't make things any worse. I don't remember the rationale behind dollar-backstick -difference.

I also use backticks, and I thought that both were equivalent in docstrings but I changed replaced some of them $ -> ` as it apparently interfered with the index table (some LaTeX formulas surrounded by $ were misinterpreted).

Nathann

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

Replying to ncohen:

Seems good, and Sage is better with this than without. Hence set to positive_review.

Thanks!

My pleasure. I guess this is one of the four places where Sage should have good help pages, and so a very good addition.

I also use backticks, and I thought that both were equivalent in docstrings but I changed replaced some of them $ -> ` as it apparently interfered with the index table (some LaTeX formulas surrounded by $ were misinterpreted).

Sphinx, I think. It is unfriendly piece of software.

comment:6 in reply to: ↑ 5 Changed 3 years ago by ncohen

Sphinx, I think. It is unfriendly piece of software.

I never saw it phrased this politely.

Nathann

comment:7 Changed 3 years ago by vbraun

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