Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

many single-backticks should be double-backticks #38991

Merged
merged 3 commits into from
Dec 8, 2024

Conversation

DaveWitteMorris
Copy link
Member

@DaveWitteMorris DaveWitteMorris commented Nov 18, 2024

The docstring of sage.combinat.posets.posets.FinitePoset includes:

``elements`` -- an optional list of elements, with ``element[i]``
      corresponding to vertex ``i``. If ``elements`` is ``None``, then it is
      set to be the vertex set of the digraph. Note that if this option is set,
      then ``elements`` is considered as a specified linear extension of the poset
      and the `linear_extension` attribute is set.

In the last line, this PR changes the single-backticks around linear_extension to double-backticks. (Currently, linear_extension is typeset as latex math, so it is in italics and the "e" shows up as a subscript.)

It also changes about 60 other similar problems.

📝 Checklist

  • The title is concise and informative.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation and checked the documentation preview.

⌛ Dependencies

Copy link

github-actions bot commented Nov 18, 2024

Documentation preview for this PR (built with commit 15511a7; changes) is ready! 🎉
This preview will update shortly after each push to this PR.

Copy link
Contributor

@dcoudert dcoudert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@fchapoton
Copy link
Contributor

More similar issues can be found using

gg " \`[^\`\\].[A-Za-z]*_[A-Za-z]*\`" src/sage

@dcoudert
Copy link
Contributor

indeed, and it seems we have plenty that could also be fixed in this PR...

@DaveWitteMorris DaveWitteMorris marked this pull request as draft November 18, 2024 17:01
@DaveWitteMorris
Copy link
Member Author

OK, I'll spend a few minutes to do some more of these.

@DaveWitteMorris DaveWitteMorris changed the title fix typo in FinitePoset doc many single-backticks should be double-backticks Nov 19, 2024
@DaveWitteMorris DaveWitteMorris marked this pull request as ready for review November 19, 2024 02:03
@DaveWitteMorris
Copy link
Member Author

This PR was originally a trivial edit, but now it's a patchbomb that hits about 60 files. Will we be able to merge it?

Copy link
Contributor

@dcoudert dcoudert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thank you.

@@ -108,7 +108,7 @@ def CrystalOfSpinsPlus(ct):
r"""
Return the plus spin crystal of the given type D.

This is the crystal with highest weight `Lambda_n` (the
This is the crystal with highest weight `\lambda_n` (the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original paper (Crystal Graphs for Representations of the q-Analogue of Classical Lie Algebras
M. Kashiwara, Toshiki Nakashima) uses uppercase Lambda (Λ) for fundamental weight. (Edit the occurrence above too.)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the correction. I made the fix, so is it ok to restore to positive review?

@DaveWitteMorris
Copy link
Member Author

Thanks!

vbraun pushed a commit to vbraun/sage that referenced this pull request Dec 6, 2024
    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

The docstring of `sage.combinat.posets.posets.FinitePoset` includes:

```
``elements`` -- an optional list of elements, with ``element[i]``
      corresponding to vertex ``i``. If ``elements`` is ``None``, then
it is
      set to be the vertex set of the digraph. Note that if this option
is set,
      then ``elements`` is considered as a specified linear extension of
the poset
      and the `linear_extension` attribute is set.
```

In the last line, this PR changes the single-backticks around
`linear_extension` to double-backticks. (Currently, `linear_extension`
is typeset as latex math, so it is in italics and the "e" shows up as a
subscript.)

It also changes about 60 other similar problems.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

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

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#38991
Reported by: DaveWitteMorris
Reviewer(s): DaveWitteMorris, David Coudert, user202729
vbraun pushed a commit to vbraun/sage that referenced this pull request Dec 8, 2024
    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

The docstring of `sage.combinat.posets.posets.FinitePoset` includes:

```
``elements`` -- an optional list of elements, with ``element[i]``
      corresponding to vertex ``i``. If ``elements`` is ``None``, then
it is
      set to be the vertex set of the digraph. Note that if this option
is set,
      then ``elements`` is considered as a specified linear extension of
the poset
      and the `linear_extension` attribute is set.
```

In the last line, this PR changes the single-backticks around
`linear_extension` to double-backticks. (Currently, `linear_extension`
is typeset as latex math, so it is in italics and the "e" shows up as a
subscript.)

It also changes about 60 other similar problems.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

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

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#38991
Reported by: DaveWitteMorris
Reviewer(s): DaveWitteMorris, David Coudert, user202729
@vbraun vbraun merged commit 393d042 into sagemath:develop Dec 8, 2024
22 of 24 checks passed
@DaveWitteMorris DaveWitteMorris deleted the FinitePoset_typo branch December 8, 2024 23:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants