Opened 6 years ago

Closed 6 years ago

#22303 closed enhancement (fixed)

Unify "example" vs. "examples"

Reported by: Jori Mäntysalo Owned by:
Priority: trivial Milestone: sage-7.6
Component: documentation Keywords:
Cc: John Palmieri Merged in:
Authors: Jori Mäntysalo Reviewers: John Palmieri
Report Upstream: N/A Work issues:
Branch: d473750 (Commits, GitHub, GitLab) Commit: d473750d80725b9f45bbc2f0a994fc45e9748dd5
Dependencies: Stopgaps:

Status badges

Description

Slight modification, in a hope to make (semi)automatic processing a little easier. Contain also two SEE ALSO -> SEEALSO.

Change History (15)

comment:1 Changed 6 years ago by Jori Mäntysalo

Branch: u/jmantysalo/algorithm-case

comment:2 Changed 6 years ago by Jori Mäntysalo

Cc: Frédéric Chapoton added
Commit: 9b4cf2441eb21db7131b5a85c333c90efb8b899a
Status: newneeds_review

New commits:

9b4cf24Add several S to 'EXAMPLE'.

comment:3 Changed 6 years ago by Jori Mäntysalo

Cc: John Palmieri added; Frédéric Chapoton removed

John, an example ticket of unifying in a hope to some day have easier processing of docs.

comment:4 Changed 6 years ago by Jori Mäntysalo

Status: needs_reviewneeds_work

To be resolved and merged.

comment:5 Changed 6 years ago by git

Commit: 9b4cf2441eb21db7131b5a85c333c90efb8b899ab9669295447be7d5b81ed8a012692ffa119922d8

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

b966929EXAMPLE:: -> EXAMPLES::

comment:6 Changed 6 years ago by Jori Mäntysalo

Status: needs_workneeds_review

comment:7 Changed 6 years ago by git

Commit: b9669295447be7d5b81ed8a012692ffa119922d85e7aa2a88a55280e1dfee883d92a6944efb91ecf

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

5e7aa2aSmall merge conflict.

comment:8 Changed 6 years ago by Jori Mäntysalo

This had a conflict, merged now.

comment:9 Changed 6 years ago by John Palmieri

Was this done with a script?

  • I found one more "EXAMPLE::", line 130 of src/sage/repl/ipython_kernel/interact.py
  • There are a lot of instances of "EXAMPLE:" (single colon). Should those also be changed?

comment:10 in reply to:  9 Changed 6 years ago by Jori Mäntysalo

Status: needs_reviewneeds_work

Replying to jhpalmieri:

Was this done with a script?

Yes, find . -name ... | xargs perl -e 's|...|...|g;' -p -i.bak.

  • I found one more "EXAMPLE::", line 130 of src/sage/repl/ipython_kernel/interact.py

Most have happened after last beta. I'll check.

  • There are a lot of instances of "EXAMPLE:" (single colon). Should those also be changed?

Hmmm... yes. Of course, as they are also kind of block markers.

comment:11 Changed 6 years ago by git

Commit: 5e7aa2a88a55280e1dfee883d92a6944efb91ecfd473750d80725b9f45bbc2f0a994fc45e9748dd5

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

d473750Add S to EXAMPLE: with one colon too.

comment:12 Changed 6 years ago by Jori Mäntysalo

I did the changes, now compiling and testing.

For example GF2XHexOutput at src/sage/libs/ntl/ntl_GF2X.pyx has an error also. I will look at those later.

comment:13 Changed 6 years ago by Jori Mäntysalo

Status: needs_workneeds_review

Tests passed.

comment:14 Changed 6 years ago by John Palmieri

Reviewers: John Palmieri
Status: needs_reviewpositive_review

Looks okay to me.

comment:15 Changed 6 years ago by Volker Braun

Branch: u/jmantysalo/algorithm-cased473750d80725b9f45bbc2f0a994fc45e9748dd5
Resolution: fixed
Status: positive_reviewclosed
Note: See TracTickets for help on using tickets.