#5294: Pickle Jar documentation
--------------------------------------------+-------------------------------
Reporter: hivert | Owner: tba
Type: defect | Status: new
Priority: major | Milestone: sage-5.5
Component: documentation | Resolution:
Keywords: picklejar, documentation | Work issues:
Report Upstream: N/A | Reviewers:
Authors: Andrew Mathas | Merged in:
Dependencies: | Stopgaps:
--------------------------------------------+-------------------------------
Changes (by {'newvalue': u'Andrew Mathas', 'oldvalue': ''}):
* upstream: => N/A
* milestone: sage-wishlist => sage-5.5
* author: => 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.
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 attached patch adds some documentation about the pickle jar.
Specifically it:
* 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
* adds a non-trivial example to show how to use register_unpickle_override
to fix allow unpickling of old pickles
The intention here 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
}}}
--
Comment:
The attached patch improves the pickle_jar documentation, with the primary
aim of telling developers what to do (and not do) when their code breaks a
pickle in the pickle_jar. I've added a version of the manual page produced
so that people can comment on this without having to rebuild the manual.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/5294#comment:1>
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.
