fix missing ::

[mantepse]

If EXAMPLE: introduces an indented block of examples, a second : is necessary, because this block is a code block.

Component: documentation

Author: Martin Rubey

Branch/Commit: 41a64cd

Reviewer: Frédéric Chapoton, Jeroen Demeyer

Issue created by migration from https://trac.sagemath.org/ticket/27023

[mantepse]

Branch: u/mantepse/fix_missing___

[mantepse]

New commits:

530a337

fix EXAMPLE: to EXAMPLE:: when necessary

[mantepse]

Author: Martin Rubey

[mantepse]

Commit: 530a337

[fchapoton]

Reviewer: Frédéric Chapoton

[fchapoton]

comment:3

ok, Danke Schön

[sagetrac-git]

Changed commit from 530a337 to 512afaa

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1 and set ticket back to needs_review. New commits:

512afaa

a few more

[mantepse]

comment:5

Désolé Frederic, I found some more (mistake in my regexp) at the same time you reviewed. And now I have more questions:

• I didn't fix those in pyx files, is that OK or should I fix those, too?

• There are several occurrences of the same pattern with TESTS:, but I don't see any consequences. Should I fix them, too?

[mantepse]

comment:6

OK, I just saw that the ones in pyx files need to be fixed, too.

[sagetrac-git]

Changed commit from 512afaa to 4ad07f6

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

2dd1dfd	fix missing :: and indentation in src/sage/libs
4ad07f6	fix missing :: in remaining .pyx

[mantepse]

comment:8

I think I'm done.

[mantepse]

comment:10

(the failure in sage.geometry.polyhedron.library.Polytopes.icosahedron does not occur on my computer and should be unrelated)

[fchapoton]

comment:11

OMG, such a patchbomb now... What did you do ??? Why all these whitespace changes ?? Why all these splitting of EXAMPLES lines ???

This is a wrong change (and this happens several times)

-        r"""
-        Return the index of this polytope in the internal database of 2- or
+        r"""Return the index of this polytope in the internal database of 2- or

[mantepse]

comment:12

I'm sorry, I guess this was stupid.

I figured that at least some of the bad EXAMPLES: blocks messed up the documentation, and I thought that EXAMPLES: (some text) was not correct. And my editor did the rest :-(

So, I guess it's best if I undo all changes except those EXAMPLES: -> EXAMPLES:: which are appropriate?

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

199fc95

undo bad changes

[sagetrac-git]

Changed commit from 4ad07f6 to 199fc95

[mantepse]

comment:14

If you prefer, I could also undo commit ​2dd1dfd which concerns the modfications in src.sage.libs, which probably don't show up in the documentation anyway.

[jdemeyer]

comment:15

Instead of undoing bad changes, better just squash the patch to one commit. Otherwise it will break git blame.

[mantepse]

Changed commit from 199fc95 to 79498fc

[mantepse]

Changed branch from u/mantepse/fix_missing___ to public/fix_missing_colon

[mantepse]

New commits:

79498fc

add missing colon to EXAMPLES: if followed by a code block

[mantepse]

comment:17

done!

[jdemeyer]

comment:18

In ntl_ZZ_pEX.pyx, you have one EXAMPLES:: without an indented block. That's very bad as it will break docbuilding.

[jdemeyer]

comment:19

Also, I don't think that this is correct:

            sage: f.left_shift(5)
            [[] [] [] [] [] [3 2] [1 2] [1 2]]

            A negative left shift is a right shift.
            sage: f.left_shift(-2)
            [[1 2]]

(this "A negative..." occurs twice like this)

[jdemeyer]

comment:20

The double indentation in src/sage/rings/polynomial/pbori.pyx (which already existed before, not blaming you) is also wrong. It should be

EXAMPLES:
 
A simple example::
 
    sage: from sage.doctest.fixtures import reproducible_repr

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

41a64cd

fix leftovers

[sagetrac-git]

Changed commit from 79498fc to 41a64cd

[jdemeyer]

Changed reviewer from Frédéric Chapoton to Frédéric Chapoton, Jeroen Demeyer

[mantepse]

comment:24

Great, many thanks!

[embray]

comment:25

Retarging tickets optimistically to the next milestone. If you are responsible for this ticket (either its reporter or owner) and don't believe you are likely to complete this ticket before the next release (8.7) please retarget this ticket's milestone to sage-pending or sage-wishlist.

[vbraun]

Changed branch from public/fix_missing_colon to 41a64cd