#19067: Incomplete sentences in the automatically generated documentation
-------------------------+-------------------------------------------------
Reporter: | Owner:
ncohen | Status: needs_review
Type: | Milestone: sage-6.9
enhancement | Resolution:
Priority: major | Merged in:
Component: | Reviewers:
documentation | Work issues:
Keywords: | Commit:
Authors: | 317d6d61dd030e5df134896b5556408fda14d8df
Nathann Cohen | Stopgaps:
Report Upstream: N/A |
Branch: |
u/ncohen/19067 |
Dependencies: |
-------------------------+-------------------------------------------------
Comment (by ncohen):
> "First sentence in the documentation of a function may not contain the
'@' character, nor any non-ascii character.
>
> First restriction is because the ReST tables returned by this function
use '@' as a delimiter for cells. Second restriction follows from Sphinx
internals."
The management of non-ascii characters has *nothing* to do with this
branch. If you write a non-ascii character in the documentation of a
function, sphinx will complain even if this code is not used. Similarly,
if you add {{{# -*- coding: utf-8 -*-}}} at the beginning of your files,
then non-ascii characters will work well, regadless of whether you use
this code or not.
Nathann
--
Ticket URL: <http://trac.sagemath.org/ticket/19067#comment:22>
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.
