Opened 11 years ago

Closed 17 months ago

#10653 closed enhancement (fixed)

Formatting error in doc for dynamic classes

Reported by: Nevena Owned by: mvngu
Priority: trivial Milestone: sage-9.3
Component: documentation Keywords: days28, sd35.5
Cc: slelievre Merged in:
Authors: Peter Story, Dave Morris Reviewers: Dave Morris, Frédéric Chapoton, Samuel Lelièvre
Report Upstream: N/A Work issues:
Branch: 213aee5 (Commits, GitHub, GitLab) Commit: 213aee5617fb5e4a69d99851876624e0d154ece9
Dependencies: Stopgaps:

Status badges

Description (last modified by slelievre)

Documentation for dynamic classes .../doc/live/reference/sage/structure/dynamic_class.html has "..topic:" instead of ".. rubric::"

Attachments (1)

trac_10653_rubricSubstitution.patch (521 bytes) - added by peter.story 10 years ago.

Download all attachments as: .zip

Change History (19)

comment:1 Changed 11 years ago by slelievre

  • Description modified (diff)
  • Keywords beginner days28 added
  • Priority changed from major to minor

comment:2 Changed 11 years ago by slelievre

  • Component changed from PLEASE CHANGE to documentation
  • Owner changed from tbd to mvngu
  • Summary changed from Dynamic classes to Formatting error in doc for dynamic classes
  • Type changed from PLEASE CHANGE to defect

Changed 10 years ago by peter.story

comment:3 Changed 10 years ago by peter.story

  • Authors set to peter.story
  • Milestone set to sage-5.0
  • Status changed from new to needs_review

Performed the substitution of ".. rubric::" for "..topic:" as requested.

comment:4 Changed 10 years ago by peter.story

  • Keywords sd35.5 added

comment:5 Changed 10 years ago by kcrisman

  • Authors changed from peter.story to Peter Story
  • Status changed from needs_review to needs_info

It would be worth making sure this really is a change we need to make. Can the original reporter explain why one is more appropriate than the other in terms of Sphinx doc for topic and rubric? Just to make sure :)

comment:6 Changed 9 years ago by jdemeyer

  • Milestone changed from sage-5.11 to sage-5.12

comment:7 Changed 8 years ago by vbraun_spam

  • Milestone changed from sage-6.1 to sage-6.2

comment:8 Changed 8 years ago by vbraun_spam

  • Milestone changed from sage-6.2 to sage-6.3

comment:9 Changed 8 years ago by vbraun_spam

  • Milestone changed from sage-6.3 to sage-6.4

comment:10 Changed 2 years ago by gh-DaveWitteMorris

  • Keywords beginner removed

Removing the "beginner" tag from old tickets. Some could be returned to beginner-friendly status by adding a comment about what needs to be done. Some others might be easy for an experienced developer to finish.

comment:11 Changed 18 months ago by gh-DaveWitteMorris

  • Milestone changed from sage-6.4 to sage-duplicate/invalid/wontfix
  • Reviewers set to Dave Morris
  • Status changed from needs_info to positive_review

All occurrences of "topic" in src/sage/structure/dynamic_class.py were changed to "rubric" long ago. (Git blame says it was in 2011 and 2012.) So there is no longer an issue here.

comment:12 Changed 18 months ago by slelievre

Two instances of topic were changed to rubric in #12645.

Two instances of RUBRIC were introduced in #11935.

Are both rubric and RUBRIC ok? Should we homogenize?

comment:13 Changed 18 months ago by gh-DaveWitteMorris

  • Branch set to public/10653

comment:14 Changed 18 months ago by gh-DaveWitteMorris

  • Authors changed from Peter Story to Peter Story, Dave Morris
  • Commit set to 213aee5617fb5e4a69d99851876624e0d154ece9
  • Milestone changed from sage-duplicate/invalid/wontfix to sage-9.3
  • Priority changed from minor to trivial
  • Status changed from positive_review to needs_review
  • Type changed from defect to enhancement

Yes, you are right, so this PR homogenizes to RUBRIC:. A quick search of the src directory found 98 occurrences of rubric: (in 25 files) and 116 occurrences of RUBRIC: (in 44 files), but this seemed to be the only file that had both. (Also, I think that all of the other occurrences of <keyword>:: in this file are all caps.) Thanks for the suggestion.


New commits:

213aee5homogenize rubric to RUBRIC

comment:15 Changed 18 months ago by chapoton

  • Reviewers changed from Dave Morris to Dave Morris, Frédéric Chapoton
  • Status changed from needs_review to positive_review

ok

comment:16 Changed 18 months ago by gh-DaveWitteMorris

Thanks for the review!

comment:17 Changed 18 months ago by slelievre

  • Cc slelievre added
  • Keywords changed from days28 sd35.5 to days28, sd35.5
  • Reviewers changed from Dave Morris, Frédéric Chapoton to Dave Morris, Frédéric Chapoton, Samuel Lelièvre

The Sphinx documentation has the "rubric" directive in lowercase:

Not sure if we have a different tradition.

That can be a different ticket anyway given the numerous occurrences across our sources.

comment:18 Changed 17 months ago by vbraun

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