Skip to content
This repository was archived by the owner on Jan 30, 2023. It is now read-only.

Commit 547206c

Browse files
author
Matthias Koeppe
committed
Change "# optional: FEATURE" to "# optional - FEATURE"
git grep -l 'sage:.*# *optional.*:' | xargs sed -i.bak '/^ *sage:.*# optional: *[a-zA-Z_0-9]* *$/s/optional:/optional -/'
1 parent d364333 commit 547206c

File tree

21 files changed

+50
-50
lines changed

21 files changed

+50
-50
lines changed

‎src/doc/en/developer/coding_basics.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1113,7 +1113,7 @@ framework. Here is a comprehensive list:
11131113
11141114
The following should yield 4. See :trac:`2`. ::
11151115
1116-
sage: 2+2 # optional: bug
1116+
sage: 2+2 # optional - bug
11171117
5
11181118
sage: 2+2 # known bug
11191119
5

‎src/sage/combinat/posets/posets.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6232,9 +6232,9 @@ def canonical_label(self, algorithm=None):
62326232
sage: Poset().canonical_label() # Test the empty poset
62336233
Finite poset containing 0 elements
62346234
6235-
sage: D2 = posets.DiamondPoset(4).canonical_label(algorithm='bliss') # optional: bliss
6236-
sage: B2 = posets.BooleanLattice(2).canonical_label(algorithm='bliss') # optional: bliss
6237-
sage: D2 == B2 # optional: bliss
6235+
sage: D2 = posets.DiamondPoset(4).canonical_label(algorithm='bliss') # optional - bliss
6236+
sage: B2 = posets.BooleanLattice(2).canonical_label(algorithm='bliss') # optional - bliss
6237+
sage: D2 == B2 # optional - bliss
62386238
True
62396239
"""
62406240
canonical_label = self._hasse_diagram.canonical_label(certificate=True,

‎src/sage/features/__init__.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
Here we test whether the grape GAP package is available::
2929
3030
sage: from sage.features.gap import GapPackage
31-
sage: GapPackage("grape", spkg="gap_packages").is_present() # optional: gap_packages
31+
sage: GapPackage("grape", spkg="gap_packages").is_present() # optional - gap_packages
3232
FeatureTestResult('gap_package_grape', True)
3333
3434
Note that a :class:`FeatureTestResult` acts like a bool in most contexts::
@@ -147,7 +147,7 @@ def is_present(self):
147147
EXAMPLES::
148148
149149
sage: from sage.features.gap import GapPackage
150-
sage: GapPackage("grape", spkg="gap_packages").is_present() # optional: gap_packages
150+
sage: GapPackage("grape", spkg="gap_packages").is_present() # optional - gap_packages
151151
FeatureTestResult('gap_package_grape', True)
152152
sage: GapPackage("NOT_A_PACKAGE", spkg="gap_packages").is_present()
153153
FeatureTestResult('gap_package_NOT_A_PACKAGE', False)

‎src/sage/features/bliss.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ class BlissLibrary(CythonFeature):
3030
EXAMPLES::
3131
3232
sage: from sage.features.bliss import BlissLibrary
33-
sage: BlissLibrary().require() # optional: libbliss
33+
sage: BlissLibrary().require() # optional - libbliss
3434
"""
3535

3636
def __init__(self):
@@ -54,7 +54,7 @@ class Bliss(JoinFeature):
5454
EXAMPLES::
5555
5656
sage: from sage.features.bliss import Bliss
57-
sage: Bliss().require() # optional: bliss
57+
sage: Bliss().require() # optional - bliss
5858
"""
5959
def __init__(self):
6060
r"""

‎src/sage/features/csdp.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class CSDP(Executable):
1919
EXAMPLES::
2020
2121
sage: from sage.features.csdp import CSDP
22-
sage: CSDP().is_present() # optional: csdp
22+
sage: CSDP().is_present() # optional - csdp
2323
FeatureTestResult('csdp', True)
2424
"""
2525
def __init__(self):
@@ -40,7 +40,7 @@ def is_functional(self):
4040
EXAMPLES::
4141
4242
sage: from sage.features.csdp import CSDP
43-
sage: CSDP().is_functional() # optional: csdp
43+
sage: CSDP().is_functional() # optional - csdp
4444
FeatureTestResult('csdp', True)
4545
"""
4646
from sage.misc.temporary_file import tmp_filename

‎src/sage/features/databases.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ class DatabaseCremona(StaticFile):
5959
sage: from sage.features.databases import DatabaseCremona
6060
sage: DatabaseCremona('cremona_mini').is_present()
6161
FeatureTestResult('database_cremona_mini_ellcurve', True)
62-
sage: DatabaseCremona().is_present() # optional: database_cremona_ellcurve
62+
sage: DatabaseCremona().is_present() # optional - database_cremona_ellcurve
6363
FeatureTestResult('database_cremona_ellcurve', True)
6464
"""
6565
def __init__(self, name="cremona", spkg="database_cremona_ellcurve"):
@@ -85,7 +85,7 @@ class DatabaseJones(StaticFile):
8585
EXAMPLES::
8686
8787
sage: from sage.features.databases import DatabaseJones
88-
sage: bool(DatabaseJones().is_present()) # optional: database_jones_numfield
88+
sage: bool(DatabaseJones().is_present()) # optional - database_jones_numfield
8989
True
9090
"""
9191
def __init__(self):
@@ -113,7 +113,7 @@ class DatabaseKnotInfo(PythonModule):
113113
EXAMPLES::
114114
115115
sage: from sage.features.databases import DatabaseKnotInfo
116-
sage: DatabaseKnotInfo().is_present() # optional: database_knotinfo
116+
sage: DatabaseKnotInfo().is_present() # optional - database_knotinfo
117117
FeatureTestResult('database_knotinfo', True)
118118
"""
119119
def __init__(self):

‎src/sage/features/dvipng.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class dvipng(Executable):
2121
EXAMPLES::
2222
2323
sage: from sage.features.dvipng import dvipng
24-
sage: dvipng().is_present() # optional: dvipng
24+
sage: dvipng().is_present() # optional - dvipng
2525
FeatureTestResult('dvipng', True)
2626
"""
2727
def __init__(self):

‎src/sage/features/fes.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ class LibFESLibrary(CythonFeature):
5858
EXAMPLES::
5959
6060
sage: from sage.features.fes import LibFESLibrary
61-
sage: LibFESLibrary().require() # optional: fes
61+
sage: LibFESLibrary().require() # optional - fes
6262
"""
6363
def __init__(self):
6464
r"""
@@ -80,7 +80,7 @@ class LibFES(JoinFeature):
8080
EXAMPLES::
8181
8282
sage: from sage.features.fes import LibFES
83-
sage: LibFES().require() # optional: fes
83+
sage: LibFES().require() # optional - fes
8484
"""
8585
def __init__(self):
8686
r"""

‎src/sage/features/ffmpeg.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ class FFmpeg(Executable):
2222
EXAMPLES::
2323
2424
sage: from sage.features.ffmpeg import FFmpeg
25-
sage: FFmpeg().is_present() # optional: ffmpeg
25+
sage: FFmpeg().is_present() # optional - ffmpeg
2626
FeatureTestResult('ffmpeg', True)
2727
"""
2828
def __init__(self):

‎src/sage/features/graph_generators.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ class Plantri(Executable):
1616
EXAMPLES::
1717
1818
sage: from sage.features.graph_generators import Plantri
19-
sage: Plantri().is_present() # optional: plantri
19+
sage: Plantri().is_present() # optional - plantri
2020
FeatureTestResult('plantri', True)
2121
"""
2222
def __init__(self):
@@ -38,7 +38,7 @@ def is_functional(self):
3838
EXAMPLES::
3939
4040
sage: from sage.features.graph_generators import Plantri
41-
sage: Plantri().is_functional() # optional: plantri
41+
sage: Plantri().is_functional() # optional - plantri
4242
FeatureTestResult('plantri', True)
4343
"""
4444
command = ["plantri", "4"]
@@ -63,7 +63,7 @@ class Buckygen(Executable):
6363
EXAMPLES::
6464
6565
sage: from sage.features.graph_generators import Buckygen
66-
sage: Buckygen().is_present() # optional: buckygen
66+
sage: Buckygen().is_present() # optional - buckygen
6767
FeatureTestResult('buckygen', True)
6868
"""
6969
def __init__(self):
@@ -85,7 +85,7 @@ def is_functional(self):
8585
EXAMPLES::
8686
8787
sage: from sage.features.graph_generators import Buckygen
88-
sage: Buckygen().is_functional() # optional: buckygen
88+
sage: Buckygen().is_functional() # optional - buckygen
8989
FeatureTestResult('buckygen', True)
9090
"""
9191
command = ["buckygen", "-d", "22d"]
@@ -111,7 +111,7 @@ class Benzene(Executable):
111111
EXAMPLES::
112112
113113
sage: from sage.features.graph_generators import Benzene
114-
sage: Benzene().is_present() # optional: benzene
114+
sage: Benzene().is_present() # optional - benzene
115115
FeatureTestResult('benzene', True)
116116
"""
117117
def __init__(self):
@@ -133,7 +133,7 @@ def is_functional(self):
133133
EXAMPLES::
134134
135135
sage: from sage.features.graph_generators import Benzene
136-
sage: Benzene().is_functional() # optional: benzene
136+
sage: Benzene().is_functional() # optional - benzene
137137
FeatureTestResult('benzene', True)
138138
"""
139139
devnull = open(os.devnull, 'wb')

0 commit comments

Comments
 (0)