Opened 6 years ago

Closed 6 years ago

#12490 closed enhancement (fixed)

Create a role :trac: to link to trac ticket in sphinx

Reported by: hivert Owned by: mvngu
Priority: major Milestone: sage-5.0
Component: doctest coverage Keywords: Sphinx trac link Cernay2012
Cc: kini, ncohen, novoselt Merged in: sage-5.0.beta4
Authors: Florent Hivert Reviewers: Nathann Cohen, Jeroen Demeyer
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Description (last modified by hivert)

In the doc, putting :trac:`5534` adds a link to #5534.

I think its cool and useful.

I also add a :wikipedia: role.

Florent

Attachments (1)

trac_12490-trac_role-fh.patch (5.2 KB) - added by hivert 6 years ago.

Download all attachments as: .zip

Change History (16)

comment:1 Changed 6 years ago by hivert

  • Keywords Cernay2012 added

comment:2 Changed 6 years ago by kini

  • Cc kini added

comment:3 Changed 6 years ago by hivert

  • Cc ncohen added
  • Status changed from new to needs_review

comment:4 Changed 6 years ago by ncohen

  • Reviewers set to Nathann Cohen
  • Status changed from needs_review to positive_review
  • Type changed from PLEASE CHANGE to enhancement

Looks good ! Now we must remember to use this new syntax in the patches :-)

Perhaps it is worth sending a message to sage-devel to tell everybody about it ?

Nathann

comment:5 Changed 6 years ago by hivert

  • Description modified (diff)

I forgot to add a log message in the header of the patch. I just uploaded a new patch which just add one. I don't think this need a re-review.

comment:6 follow-up: Changed 6 years ago by jdemeyer

  • Status changed from positive_review to needs_work

Please write a proper commit message for your patch, use hg qrefresh -e for this.

comment:7 in reply to: ↑ 6 Changed 6 years ago by hivert

  • Status changed from needs_work to positive_review

Replying to jdemeyer:

Please write a proper commit message for your patch, use hg qrefresh -e for this.

That's precisely why I uploaded a new patch 1 hour ago. Is there any problem with my message ?

comment:8 Changed 6 years ago by jdemeyer

Excellent! There was a race condition between me checking patches and you uploading a new patch.

comment:9 follow-up: Changed 6 years ago by jdemeyer

  • Status changed from positive_review to needs_work

If you copy a doctest, you should copy it completely:

sage -t  "devel/sage/doc/en/developer/sage_manuals.rst"
**********************************************************************
File "/usr/local/src/sage-5.0.beta1/devel/sage/doc/en/developer/sage_manuals.rst", line 165:
    sage: x = sage.combinat.subword.smallest_positions(w, ww); ww
Exception raised:
    Traceback (most recent call last):
      File "/usr/local/src/sage-5.0.beta1/local/bin/ncadoctest.py", line 1231, in run_one_test
        self.run_one_example(test, example, filename, compileflags)
      File "/usr/local/src/sage-5.0.beta1/local/bin/sagedoctest.py", line 38, in run_one_example
        OrigDocTestRunner.run_one_example(self, test, example, filename, compileflags)
      File "/usr/local/src/sage-5.0.beta1/local/bin/ncadoctest.py", line 1172, in run_one_example
        compileflags, 1) in test.globs
      File "<doctest __main__.example_0[2]>", line 1, in <module>
        x = sage.combinat.subword.smallest_positions(w, ww); ww###line 165:
    sage: x = sage.combinat.subword.smallest_positions(w, ww); ww
    NameError: name 'w' is not defined
**********************************************************************

comment:10 in reply to: ↑ 9 Changed 6 years ago by hivert

Replying to jdemeyer:

If you copy a doctest, you should copy it completely:

Oups ! We forgot to run the test of the doc too ! Sorry !

The test was extracted from sage/combinat/subword.py. I extracted it in full.

Changed 6 years ago by hivert

comment:11 Changed 6 years ago by hivert

  • Status changed from needs_work to needs_review

Here is the corrected patch. Can I put it back myself to positive review ?

comment:12 Changed 6 years ago by novoselt

  • Cc novoselt added

comment:13 Changed 6 years ago by jdemeyer

  • Reviewers changed from Nathann Cohen to Nathann Cohen, Jeroen Demeyer
  • Status changed from needs_review to positive_review

comment:14 Changed 6 years ago by ncohen

I was just about to do it !! Thank you :-)

Nathann

comment:15 Changed 6 years ago by jdemeyer

  • Merged in set to sage-5.0.beta4
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.