Skip to content

Commit

Permalink
gh-35537: Fix Sphinx markup in some file
Browse files Browse the repository at this point in the history
    
<!-- Please provide a concise, informative and self-explanatory title.
-->
<!-- Don't put issue numbers in the title. Put it in the Description
below. -->
<!-- For example, instead of "Fixes #12345", use "Add a new method to
multiply two integers" -->

### 📚 Description

<!-- Describe your changes here in detail. -->
Math equations should be marked in the math environment. Change the
Sphinx markup in src/sage/categories/crystals.py
<!-- Why is this change required? What problem does it solve? -->
Fix some Sphinx markup as posted in Issue #35496
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes #12345". -->
Fixes #35496
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. It should be `[x]` not `[x
]`. -->

- [ ] The title is concise, informative, and self-explanatory.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- #12345: short description why this is a dependency
- #34567: ...
-->
- #35536: branch is on top of this PR to fix a build issue in conda

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: #35537
Reported by: xuluze
Reviewer(s):
  • Loading branch information
Release Manager committed Sep 27, 2023
2 parents 4d3e807 + 722bc84 commit 2829cf2
Showing 1 changed file with 32 additions and 24 deletions.
56 changes: 32 additions & 24 deletions src/sage/categories/crystals.py
Original file line number Diff line number Diff line change
Expand Up @@ -919,7 +919,7 @@ def digraph(self, subset=None, index_set=None):

def latex_file(self, filename):
r"""
Export a file, suitable for pdflatex, to 'filename'.
Export a file, suitable for pdflatex, to ``filename``.
This requires
a proper installation of ``dot2tex`` in sage-python. For more
Expand Down Expand Up @@ -954,7 +954,7 @@ def latex_file(self, filename):
def _latex_(self, **options):
r"""
Returns the crystal graph as a latex string. This can be exported
to a file with self.latex_file('filename').
to a file with ``self.latex_file('filename')``.
EXAMPLES::
Expand All @@ -977,15 +977,9 @@ def _latex_(self, **options):

def metapost(self, filename, thicklines=False, labels=True, scaling_factor=1.0, tallness=1.0):
r"""
Use C.metapost("filename.mp",[options]), where options can be:
Export a file, suitable for MetaPost, to ``filename``.
thicklines = True (for thicker edges) labels = False (to suppress
labeling of the vertices) scaling_factor=value, where value is a
floating point number, 1.0 by default. Increasing or decreasing the
scaling factor changes the size of the image. tallness=1.0.
Increasing makes the image taller without increasing the width.
Root operators e(1) or f(1) move along red lines, e(2) or f(2)
Root operators `e(1)` or `f(1)` move along red lines, `e(2)` or `f(2)`
along green. The highest weight is in the lower left. Vertices with
the same weight are kept close together. The concise labels on the
nodes are strings introduced by Berenstein and Zelevinsky and
Expand All @@ -994,20 +988,34 @@ def metapost(self, filename, thicklines=False, labels=True, scaling_factor=1.0,
For Cartan types B2 or C2, the pattern has the form
a2 a3 a4 a1
`a_2 a_3 a_4 a_1`
where c\*a2 = a3 = 2\*a4 =0 and a1=0, with c=2 for B2, c=1 for C2.
Applying e(2) a1 times, e(1) a2 times, e(2) a3 times, e(1) a4 times
where `c*a_2 = a_3 = 2*a_4 = 0` and `a_1=0`, with `c=2` for B2, `c=1` for C2.
Applying `e(2)` `a_1` times, `e(1)` `a_2` times, `e(2)` `a_3` times, `e(1)` `a_4` times
returns to the highest weight. (Observe that Littelmann writes the
roots in opposite of the usual order, so our e(1) is his e(2) for
roots in opposite of the usual order, so our `e(1)` is his `e(2)` for
these Cartan types.) For type A2, the pattern has the form
a3 a2 a1
`a_3 a_2 a_1`
where applying e(1) a1 times, e(2) a2 times then e(3) a1 times
where applying `e(1)` `a_3` times, `e(2)` `a_2` times then `e(1)` `a_1` times
returns to the highest weight. These data determine the vertex and
may be translated into a Gelfand-Tsetlin pattern or tableau.
INPUT:
- ``filename`` -- name of the output file, e.g., ``'filename.mp'``
- ``thicklines`` -- (default: ``True``) for thicker edges
- ``labels`` -- (default: False) to suppress labeling of the vertices
- ``scaling_factor`` -- (default: ``1.0``) Increasing or decreasing the
scaling factor changes the size of the image
- ``tallness`` -- (default: ``1.0``) Increasing makes the image taller
without increasing the width
EXAMPLES::
sage: C = crystals.Letters(['A', 2])
Expand Down Expand Up @@ -1450,7 +1458,7 @@ def Phi(self):

def f_string(self, list):
r"""
Applies `f_{i_r} \cdots f_{i_1}` to self for ``list`` as
Applies `f_{i_r} \cdots f_{i_1}` to ``self`` for ``list`` as
`[i_1, ..., i_r]`
EXAMPLES::
Expand All @@ -1470,7 +1478,7 @@ def f_string(self, list):

def e_string(self, list):
r"""
Applies `e_{i_r} \cdots e_{i_1}` to self for ``list`` as
Applies `e_{i_r} \cdots e_{i_1}` to ``self`` for ``list`` as
`[i_1, ..., i_r]`
EXAMPLES::
Expand Down Expand Up @@ -1562,11 +1570,11 @@ def is_lowest_weight(self, index_set=None):
def to_highest_weight(self, index_set=None):
r"""
Return the highest weight element `u` and a list `[i_1,...,i_k]`
such that `self = f_{i_1} ... f_{i_k} u`, where `i_1,...,i_k` are
such that ``self`` `= f_{i_1} ... f_{i_k} u`, where `i_1,...,i_k` are
elements in ``index_set``.
By default the index set is assumed to be
the full index set of self.
By default the ``index_set`` is assumed to be
the full index set of ``self``.
EXAMPLES::
Expand Down Expand Up @@ -1603,11 +1611,11 @@ def to_highest_weight(self, index_set=None):
def to_lowest_weight(self, index_set=None):
r"""
Return the lowest weight element `u` and a list `[i_1,...,i_k]`
such that `self = e_{i_1} ... e_{i_k} u`, where `i_1,...,i_k` are
such that ``self`` `= e_{i_1} ... e_{i_k} u`, where `i_1,...,i_k` are
elements in ``index_set``.
By default the index set is assumed to be the full index
set of self.
By default the ``index_set`` is assumed to be the full index
set of ``self``.
EXAMPLES::
Expand Down

0 comments on commit 2829cf2

Please sign in to comment.