Opened 3 years ago

Closed 3 years ago

#27023 closed defect (fixed)

fix missing ::

Reported by: mantepse Owned by:
Priority: major Milestone: sage-8.7
Component: documentation Keywords:
Cc: Merged in:
Authors: Martin Rubey Reviewers: Frédéric Chapoton, Jeroen Demeyer
Report Upstream: N/A Work issues:
Branch: 41a64cd (Commits, GitHub, GitLab) Commit: 41a64cd6113e601e702d63ee82c806f839017f5e
Dependencies: Stopgaps:

Status badges

Description (last modified by mantepse)

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

Change History (26)

comment:1 Changed 3 years ago by mantepse

  • Branch set to u/mantepse/fix_missing___

comment:2 Changed 3 years ago by mantepse

  • Authors set to Martin Rubey
  • Commit set to 530a337999a21ad9793808f02a6fb65ff4d37723
  • Component changed from PLEASE CHANGE to documentation
  • Description modified (diff)
  • Status changed from new to needs_review
  • Type changed from PLEASE CHANGE to defect

New commits:

530a337fix EXAMPLE: to EXAMPLE:: when necessary

comment:3 Changed 3 years ago by chapoton

  • Reviewers set to Frédéric Chapoton
  • Status changed from needs_review to positive_review

ok, Danke Schön

comment:4 Changed 3 years ago by git

  • Commit changed from 530a337999a21ad9793808f02a6fb65ff4d37723 to 512afaa7c7b001b2a7a0e9b0c771af932fee6cb9
  • Status changed from positive_review to needs_review

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

512afaaa few more

comment:5 Changed 3 years ago by mantepse

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?

comment:6 Changed 3 years ago by mantepse

  • Status changed from needs_review to needs_work

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

comment:7 Changed 3 years ago by git

  • Commit changed from 512afaa7c7b001b2a7a0e9b0c771af932fee6cb9 to 4ad07f696f89c68e212bfdf25897058b48244659

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

2dd1dfdfix missing :: and indentation in src/sage/libs
4ad07f6fix missing :: in remaining .pyx

comment:8 Changed 3 years ago by mantepse

  • Status changed from needs_work to needs_review

I think I'm done.

comment:9 Changed 3 years ago by mantepse

  • Description modified (diff)

comment:10 Changed 3 years ago by mantepse

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

comment:11 Changed 3 years ago by chapoton

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

comment:12 Changed 3 years ago by mantepse

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?

comment:13 Changed 3 years ago by git

  • Commit changed from 4ad07f696f89c68e212bfdf25897058b48244659 to 199fc95b4f65a243e14d46f3e3df3c671ad9cd7d

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

199fc95undo bad changes

comment:14 Changed 3 years ago by mantepse

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.

comment:15 Changed 3 years ago by jdemeyer

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

comment:16 Changed 3 years ago by mantepse

  • Branch changed from u/mantepse/fix_missing___ to public/fix_missing_colon
  • Commit changed from 199fc95b4f65a243e14d46f3e3df3c671ad9cd7d to 79498fcd93b71a60e3dbf10d41b11193f17d89c4

New commits:

79498fcadd missing colon to EXAMPLES: if followed by a code block

comment:17 Changed 3 years ago by mantepse

done!

comment:18 Changed 3 years ago by jdemeyer

  • Status changed from needs_review to needs_work

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

comment:19 Changed 3 years ago by jdemeyer

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)

Last edited 3 years ago by jdemeyer (previous) (diff)

comment:20 Changed 3 years ago by jdemeyer

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

comment:21 Changed 3 years ago by git

  • Commit changed from 79498fcd93b71a60e3dbf10d41b11193f17d89c4 to 41a64cd6113e601e702d63ee82c806f839017f5e

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

41a64cdfix leftovers

comment:22 Changed 3 years ago by mantepse

  • Status changed from needs_work to needs_review

comment:23 Changed 3 years ago by jdemeyer

  • Reviewers changed from Frédéric Chapoton to Frédéric Chapoton, Jeroen Demeyer
  • Status changed from needs_review to positive_review

comment:24 Changed 3 years ago by mantepse

Great, many thanks!

comment:25 Changed 3 years ago by embray

  • Milestone changed from sage-8.6 to sage-8.7

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.

comment:26 Changed 3 years ago by vbraun

  • Branch changed from public/fix_missing_colon to 41a64cd6113e601e702d63ee82c806f839017f5e
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.