#17932: Ref: add various missing modules to r/misc
-------------------------------------+-------------------------------------
Reporter: mmezzarobba | Owner:
Type: enhancement | Status: needs_work
Priority: major | Milestone: sage-6.6
Component: documentation | Resolution:
Keywords: | Merged in:
Authors: Marc Mezzarobba | Reviewers: Julien Puydt
Report Upstream: N/A | Work issues:
Branch: u/mmezzarobba | Commit:
/ref-misc | b3a614559f2ced32540a8c24750c3d845770b799
Dependencies: | Stopgaps:
-------------------------------------+-------------------------------------
Comment (by mmezzarobba):
Thanks for your comments.
Replying to [comment:11 jdemeyer]:
> Why did you add `sage/databases/sql_db` here, there is also a database
section in the reference manual?
Because `reference/databases` is mainly about databases of mathematical
objects, while SQL database acess is a programming utility. (There is text
about ZODB and sqlite in `reference/databases/index.rst` that needs to be
moved somewhere else, but I wanted to first add all missing modules, and
only then organize the tables of contents.)
> `sage/misc/superseded` occurs twice.
A merge mistake... And I was sure I had checked this line specifically
`:-//`
> Then there is a separate section about lazy stuff, so all lazy stuff
should go in there.
I wanted to do that later as well. But fine.
> The `AUTHORS` blocks should be formatted like
[http://www.sagemath.org/doc/developer/coding_basics.html#headings-of-
sage-library-code-files].
>
> You should only use `::` to show code blocks, not for example here
> {{{
> Databases are constructed via a triple indexed dictionary called a
> skeleton. A skeleton should be constructed to fit the following
format::
>
> - skeleton -- a triple-indexed dictionary
> }}}
So what should I use for ASCII art? (If you look at the context, that's
what your example amounts to. The other obvious option, using nested
lists, exceeds LaTeX's `itemize` nesting limit.)
And in general, I don't have the courage to fix the docstrings in all
newly included files. I only made a few semi-automatic changes (some
pretty idiotic I'll admit) so that the documentation builds.
> Finally: `db.py` is completely deprecated and shouldn't be in the
manual. `refcount.pyx` and `file_to_worksheet.py` don't really do
anything, are unused and should probably be removed completely.
But why shouldn't they be in the manual as long as the code is there (and
the docs clearly say that `db.py` is deprecated)?
--
Ticket URL: <http://trac.sagemath.org/ticket/17932#comment:12>
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 unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
