#11798: typo in the documentation of weierstrass_points
-----------------------------+----------------------------------------------
   Reporter:  zimmerma       |          Owner:  mvngu          
       Type:  defect         |         Status:  positive_review
   Priority:  trivial        |      Milestone:  sage-4.7.2     
  Component:  documentation  |       Keywords:  ecc2011        
Work_issues:                 |       Upstream:  N/A            
   Reviewer:  Luca De Feo    |         Author:  Paul Zimmermann
     Merged:                 |   Dependencies:                 
-----------------------------+----------------------------------------------

Old description:

> {{{
> sage: K = pAdicField(11, 5)
> sage: x = polygen(K)
> sage: C = HyperellipticCurve(x^5 + 1)
> sage: C.weierstrass_points?
> ...
>        in the suport of the divisor of $y$
> }}}
> Here, {{{suport}}} should be {{{support}}}.
>
> Note: I have created that ticket to show how to create a patch and
> submit it to trac during the ECC 2011 summer school. Thus please don't
> work on this ticket!
>
> Paul Zimmermann

New description:

 {{{
 sage: K = pAdicField(11, 5)
 sage: x = polygen(K)
 sage: C = HyperellipticCurve(x^5 + 1)
 sage: C.weierstrass_points?
 ...
        in the suport of the divisor of $y$
 }}}
 Here, {{{suport}}} should be {{{support}}}.

 Note: I have created that ticket to show how to create a patch and
 submit it to trac during the ECC 2011 summer school. Thus please don't
 work on this ticket!

 Paul Zimmermann

 ----

 Apply [attachment:trac11798.patch] to the Sage library.

--

Comment(by leif):

 Replying to [ticket:11798 zimmerma]:
 > Note: I have created that ticket to show how to create a patch and
 > submit it to trac during the ECC 2011 summer school. Thus please don't
 > work on this ticket!

 Sorry, Paul, I have to, since the patch to be applied is not mentioned in
 the ticket's description, which is good practice, and also necessary for
 at least some bots or release tools which partially automate the process.
 (In case there are multiple patches which have to be applied, they should
 be listed in the order in which they have to be applied.)

 ----

 To potentially new contributors / Sage developers:

 It isn't bad to choose filenames that at least partially reflect what a
 patch does, or to which component / defect etc. it belongs; also, using
 the comment field of attachments isn't bad, e.g. to note to which
 repository a patch has to be applied, which version of Sage it was based
 on, and maybe also ''there'' what a patch does, etc.

 As Paul ''did'', the filenames of patches should start with `trac_<ticket
 number>` (or, less often used, `trac<ticket number>`), and the commit
 message should contain (best start with) the ticket number on its
 ''first'' line, e.g. `#11798 ...` or `Trac 11798: ...` or the like.

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/11798#comment:4>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica, 
and MATLAB

-- 
You received this message because you are subscribed to the Google Groups 
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/sage-trac?hl=en.

Reply via email to