sagemath / sage

Main repository of SageMath
https://www.sagemath.org
Other
1.46k stars 482 forks source link

many single-backticks should be double-backticks #38991

Open DaveWitteMorris opened 4 days ago

DaveWitteMorris commented 4 days ago

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.

:memo: Checklist

:hourglass: Dependencies

github-actions[bot] commented 4 days ago

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

fchapoton commented 4 days ago

More similar issues can be found using

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

dcoudert commented 4 days ago

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

DaveWitteMorris commented 3 days ago

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

DaveWitteMorris commented 3 days ago

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?

DaveWitteMorris commented 2 days ago

Thanks!