#10080: Fix documentation look in symbolic/expression.pyx
---------------------------------+------------------------------------------
Reporter: kcrisman | Owner: mvngu
Type: enhancement | Status: needs_work
Priority: minor | Milestone: sage-5.7
Component: documentation | Resolution:
Keywords: sd35.5 | Work issues:
Report Upstream: N/A | Reviewers: Travis Scrimshaw
Authors: Kenneth Smith | Merged in:
Dependencies: | Stopgaps:
---------------------------------+------------------------------------------
Comment (by knsam):
Replying to [comment:9 tscrim]:
Thank you for the specific pointers.
>For example, the `INPUT:` and `OUTPUT:` blocks should be:
> {{{
> INPUT:
>
> - ``arg_name`` -- Description of argument
>
> - ``second_arg`` -- Another description
>
> OUTPUT:
>
> Describing the output
> }}}
> Also, for multi-line doctests, it is just `...`, not `....:` (don't ask
me why), I prefer `EXAMPLES:` (with the s no matter if it is 1 or many),
and capitalized `.. SEEALSO::` and such blocks.
1. OK, I think I understand what you mean about INPUT. Irrespective of the
number of inputs, you have a bulleted list. Is this what we want?
(Otherwise, I am not sure what is wrong with them.)
2. Secondly, on the devel mailing list, I have seen that Keshav Kini was
saying that it is better to have `....:` instead of `...` (there is a also
a ticket on trac: #10458). So, I am now lost.
3. About, EXAMPLES, I'd go ahead and change. Capitalisation shall also be
done.
>A good check is to run `sage -docbuild reference html` (after rebuilding
sage via `sage -b`) and look at the output in `.../sage-
branch/doc/output/html/...` in your favorite web-browser (Firefox had some
issues last I knew, this might have been fixed...).
Sure thing. Being a newbie that I am, my eyes are not trained enough to
catch oddities. ;-)
Thank you for all the comments. I'll submit a patch to be applied on top
of this. Thank you.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10080#comment:10>
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?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.
