#5294: Pickle Jar documentation
------------------------------------------------------+---------------------
Reporter: hivert | Owner:
andrew.mathas
Type: defect | Status:
positive_review
Priority: major | Milestone:
sage-5.7
Component: documentation | Resolution:
Keywords: picklejar, documentation, beginner | Work issues:
Report Upstream: N/A | Reviewers: Julian
Rueth
Authors: Andrew Mathas | Merged in:
Dependencies: | Stopgaps:
------------------------------------------------------+---------------------
Description changed by andrew.mathas:
Old description:
> On sage-combinat-devel Michael wrote:
>
> "The pickle jar is not in the documentation AFAIK and it definitely
> should be. So someone who thinks this is a good idea please open a
> ticket."
>
> I definitely think this is a good idea.
>
> ----
>
> The intention of the attached patch is to help developers know what to do
> when they come across an unpickling error in the pickle_jar due to the
> automated test
> {{{
> sage -t structure/sage_object.pyx
> }}}
>
> What the patch actually does is:
> * briefly explains what the purpose of the pickle_jar is
> * embellishes the error message of unpickle_all() so that when it is run
> on the pickle_jar it says that pickles should not be removed from the
> pickle_jar and that unpickling errors can be fixed using
> register_unpickle_override
> * expands on the documentation to register_unpickle_override() and, in
> particular, adds two examples to the show how to use
> register_unpickle_override to fix unpickling issues
> * adds two sections to the developers manual: the first is a brief
> account of the pickle_jar in the sage coding conventions section and the
> section is a brief note about unpickling cycthon code in the cython
> section.
>
> Note that the documentation changes affect both the developers guide and
> the reference manual (and that the web page attached below is not current
> and does not display correctly, at least for me).
New description:
On sage-combinat-devel Michael wrote:
"The pickle jar is not in the documentation AFAIK and it definitely
should be. So someone who thinks this is a good idea please open a
ticket."
I definitely think this is a good idea.
----
The intention of the attached patch is to help developers know what to do
when they come across an unpickling error in the pickle_jar due to the
automated test
{{{
sage -t structure/sage_object.pyx
}}}
What the patch actually does is:
* briefly explains what the purpose of the pickle_jar is
* embellishes the error message of unpickle_all() so that when it is run
on the pickle_jar it says that pickles should not be removed from the
pickle_jar and that unpickling errors can be fixed using
register_unpickle_override
* expands on the documentation to register_unpickle_override() and, in
particular, adds two examples to the show how to use
register_unpickle_override to fix unpickling issues
* adds two sections to the developers manual: the first is a brief account
of the pickle_jar in the sage coding conventions section and the section
is a brief note about unpickling cycthon code in the cython section.
Note that the documentation changes affect both the developers guide and
the reference manual.
--
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/5294#comment:29>
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.
