Opened 12 years ago

Closed 12 years ago

#9383 closed enhancement (fixed)

Add quadratic forms code to the reference manual

Reported by: Anna Haensch Owned by: Minh Van Nguyen
Priority: major Milestone: sage-4.6
Component: documentation Keywords: quadratic forms
Cc: Merged in: sage-4.6.alpha2
Authors: Anna Haensch, David Loeffler Reviewers: Minh Van Nguyen
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Attachments (4)

trac_9383.patch (82.4 KB) - added by Anna Haensch 12 years ago.
quadratic_forms reference manual docbuild
trac_9383_v2.patch (151.9 KB) - added by Anna Haensch 12 years ago.
Use instead of trac_9383.patch
trac_9383_v3.patch (150.1 KB) - added by Anna Haensch 12 years ago.
Use in place of all previous patches
trac_9383_v4.patch (174.1 KB) - added by David Loeffler 12 years ago.
replaces all previous patches

Download all attachments as: .zip

Change History (13)

Changed 12 years ago by Anna Haensch

Attachment: trac_9383.patch added

quadratic_forms reference manual docbuild

comment:1 Changed 12 years ago by Anna Haensch

Priority: majorminor

This is half of the quadratic_forms documentation, I'll post the second half in an updated patch tomorrow.

Changed 12 years ago by Anna Haensch

Attachment: trac_9383_v2.patch added

Use instead of trac_9383.patch

comment:2 Changed 12 years ago by Anna Haensch

Status: newneeds_review

This patch should complete the reference documentation for quadratic forms. It's still returning a warning that the file is not contained in a toctree. Ideas?

Changed 12 years ago by Anna Haensch

Attachment: trac_9383_v3.patch added

Use in place of all previous patches

comment:3 Changed 12 years ago by David Loeffler

Status: needs_reviewneeds_work

It looks to me like you forgot to do "hg add" on your new file doc/en/reference/quadratic_forms.rst. Hence when I apply the patch to a new clone and build, I get an error /storage/masiao/sage-4.5.2.alpha1/devel/sage/doc/en/reference/index.rst:40: (WARNING/2) toctree references unknown document u'quadratic_forms' and nothing new appears in the ref manual.

David

comment:4 Changed 12 years ago by David Loeffler

BTW: the reference manual building code can behave very oddly when files have been deleted -- because of the way that the Sphinx parser caches its environment, it's next to impossible to squash the "document not included in any toctree" error, except by creating a new clean clone and applying your patch to that.

Changed 12 years ago by David Loeffler

Attachment: trac_9383_v4.patch added

replaces all previous patches

comment:5 Changed 12 years ago by David Loeffler

Authors: Anna HaenschAnna Haensch, David Loeffler
Keywords: quadratic forms added
Milestone: sage-4.5.3
Priority: minormajor
Status: needs_workneeds_review

comment:6 Changed 12 years ago by David Loeffler

Summary: Adding quadratic_forms Code to the Reference ManualAdd quadratic forms code to the reference manual

Here's a new patch, against 4.5.2.rc0, incorporating Anna's work and extending it by adding the modules count_local_2 and special_values.

The results are a little scruffy in places, but that will be much easier to sort out once the modules have been added and people can see the results!

comment:7 Changed 12 years ago by Minh Van Nguyen

Description: modified (diff)
Reviewers: Minh Van Nguyen
Status: needs_reviewpositive_review

I'm OK with the attachment trac_9383_v4.patch. Note that it adds the following modules to the reference manual:

sage/quadratic_forms/quadratic_form 
sage/quadratic_forms/binary_qf 
sage/quadratic_forms/constructions 
sage/quadratic_forms/random_quadraticform 
sage/quadratic_forms/special_values 
sage/quadratic_forms/count_local_2

The attachment make numerous ReST changes to the following modules, but does not add them to the reference manual:

sage/quadratic_forms/quadratic_form__automorphisms.py
sage/quadratic_forms/quadratic_form__count_local_2.py
sage/quadratic_forms/quadratic_form__equivalence_testing.py
sage/quadratic_forms/quadratic_form__genus.py
sage/quadratic_forms/quadratic_form__local_density_congruence.py
sage/quadratic_forms/quadratic_form__local_density_interfaces.py
sage/quadratic_forms/quadratic_form__local_field_invariants.py
sage/quadratic_forms/quadratic_form__local_normal_form.py
sage/quadratic_forms/quadratic_form__local_representation_conditions.py
sage/quadratic_forms/quadratic_form__mass.py
sage/quadratic_forms/quadratic_form__mass__Conway_Sloane_masses.py
sage/quadratic_forms/quadratic_form__mass__Siegel_densities.py
sage/quadratic_forms/quadratic_form__neighbors.py
sage/quadratic_forms/quadratic_form__reduction_theory.py
sage/quadratic_forms/quadratic_form__siegel_product.py
sage/quadratic_forms/quadratic_form__split_local_covering.py
sage/quadratic_forms/quadratic_form__ternary_Tornaria.py
sage/quadratic_forms/quadratic_form__theta.py
sage/quadratic_forms/quadratic_form__variable_substitutions.py

The trac_9383_v4.patch receives a positive review as is. If you want, you could open another ticket to add the missing modules to the reference manual.

comment:8 in reply to:  7 Changed 12 years ago by David Loeffler

Replying to mvngu:

The attachment make numerous ReST changes to the following modules, but does not add them to the reference manual:

sage/quadratic_forms/quadratic_form__automorphisms.py
sage/quadratic_forms/quadratic_form__count_local_2.py
sage/quadratic_forms/quadratic_form__equivalence_testing.py
sage/quadratic_forms/quadratic_form__genus.py
sage/quadratic_forms/quadratic_form__local_density_congruence.py
sage/quadratic_forms/quadratic_form__local_density_interfaces.py
sage/quadratic_forms/quadratic_form__local_field_invariants.py
sage/quadratic_forms/quadratic_form__local_normal_form.py
sage/quadratic_forms/quadratic_form__local_representation_conditions.py
sage/quadratic_forms/quadratic_form__mass.py
sage/quadratic_forms/quadratic_form__mass__Conway_Sloane_masses.py
sage/quadratic_forms/quadratic_form__mass__Siegel_densities.py
sage/quadratic_forms/quadratic_form__neighbors.py
sage/quadratic_forms/quadratic_form__reduction_theory.py
sage/quadratic_forms/quadratic_form__siegel_product.py
sage/quadratic_forms/quadratic_form__split_local_covering.py
sage/quadratic_forms/quadratic_form__ternary_Tornaria.py
sage/quadratic_forms/quadratic_form__theta.py
sage/quadratic_forms/quadratic_form__variable_substitutions.py

The trac_9383_v4.patch receives a positive review as is. If you want, you could open another ticket to add the missing modules to the reference manual.

No, there is no need to do this. The functions from those modules are all imported into quadraticform.py; they are divided into separate modules solely in order to keep the size of the top-level file manageable. The ReST parser follows these imports, so adding the separate files to the manual as well would just mean everything was in there twice.

Thanks for the review, anyway!

David

comment:9 Changed 12 years ago by Mitesh Patel

Merged in: sage-4.6.alpha2
Resolution: fixed
Status: positive_reviewclosed
Note: See TracTickets for help on using tickets.