Ticket #10109 (closed enhancement: fixed)

Opened 3 years ago

Last modified 2 years ago

Document sig_on() in the developer manual

Reported by: jdemeyer Owned by: mvngu
Priority: blocker Milestone: sage-4.7
Component: documentation Keywords: sig_on developer
Cc: Work issues:
Report Upstream: N/A Reviewers: Volker Braun
Authors: Jeroen Demeyer Merged in: sage-4.7.alpha5
Dependencies: Stopgaps:

Description (last modified by jdemeyer) (diff)

I added a section about sig_on() in the developer manual.

I split off the part about Cython from coding_in_other.rst and put this in a new file coding_in_cython.rst.

I also expanded the part about PARI a bit.

New developers manual:  http://boxen.math.washington.edu/home/jdemeyer/doc/developer/index.html

Attachments

10109_document_sig_on.patch Download (35.7 KB) - added by jdemeyer 2 years ago.

Change History

comment:1 Changed 3 years ago by jdemeyer

  • Status changed from new to needs_review
  • Description modified (diff)

comment:2 follow-up: ↓ 4 Changed 3 years ago by jdemeyer

I noticed that some of the code blocks are not typeset in colour, any idea why?

comment:3 follow-up: ↓ 5 Changed 3 years ago by mpatel

Per  William, should we replace "come in pairs" with "be called in pairs"?

comment:4 in reply to: ↑ 2 ; follow-up: ↓ 6 Changed 3 years ago by mpatel

Replying to jdemeyer:

I noticed that some of the code blocks are not typeset in colour, any idea why?

I think Sphinx (or Pygments) expects a statement in an except clause. According to  Showing code examples, "Normal Python code is only highlighted if it is parseable."

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

Replying to mpatel:

Per  William, should we replace "come in pairs" with "be called in pairs"?

Technically, they aren't function so you can't really "call" them. But I read that post and maybe some clarification is needed.

comment:6 in reply to: ↑ 4 Changed 3 years ago by jdemeyer

Replying to mpatel:

Replying to jdemeyer:

I noticed that some of the code blocks are not typeset in colour, any idea why?

I think Sphinx (or Pygments) expects a statement in an except clause. According to  Showing code examples, "Normal Python code is only highlighted if it is parseable."

Thanks, that's it. Unfortunately, I cannot make Cython code parseable as Python :-(

comment:7 Changed 3 years ago by jdemeyer

New version...

comment:8 follow-up: ↓ 9 Changed 3 years ago by jdemeyer

  • Keywords sig_on developer added
  • Status changed from needs_review to needs_work
  • Description modified (diff)
  • Summary changed from Document _sig_on in the developer manual to Document sig_on() in the developer manual

No point in reviewing it now, given #9678 will change many things.

comment:9 in reply to: ↑ 8 Changed 2 years ago by dimpase

  • Status changed from needs_work to needs_review

Replying to jdemeyer:

No point in reviewing it now, given #9678 will change many things.

I see no harm in actually putting this in the docs, as it's important to know the old bevaiour in order to change code to use the new design!

comment:10 Changed 2 years ago by jdemeyer

  • Status changed from needs_review to needs_work

comment:11 Changed 2 years ago by jdemeyer

  • Priority changed from major to blocker

comment:12 Changed 2 years ago by jdemeyer

  • Description modified (diff)

Changed 2 years ago by jdemeyer

comment:13 Changed 2 years ago by jdemeyer

  • Status changed from needs_work to needs_review

comment:14 Changed 2 years ago by jdemeyer

  • Description modified (diff)

comment:15 follow-up: ↓ 16 Changed 2 years ago by vbraun

  • Status changed from needs_review to positive_review
  • Reviewers set to Volker Braun

Looks good!

comment:16 in reply to: ↑ 15 Changed 2 years ago by jdemeyer

  • Status changed from positive_review to closed
  • Resolution set to fixed
  • Merged in set to sage-4.7.rc0

Replying to vbraun:

Looks good!

Thanks Volker!

comment:17 Changed 2 years ago by jdemeyer

  • Merged in changed from sage-4.7.rc0 to sage-4.7.alpha5
Note: See TracTickets for help on using tickets.