Skip to content

Conversation

mkoeppe
Copy link
Contributor

@mkoeppe mkoeppe commented Mar 14, 2024

Standard reformatting of doctests and their outputs

Split out from #35095

📝 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 accordingly.

⌛ Dependencies

@@ -387,7 +398,8 @@ def to_tableau(self):

EXAMPLES::

sage: pt = path_tableaux.SemistandardPathTableau([[],[3],[3,2],[3,3,1],[3,3,2,1],[4,3,3,1,0]])
sage: pt = path_tableaux.SemistandardPathTableau([[],[3],[3,2],[3,3,1],
Copy link
Contributor

Choose a reason for hiding this comment

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

on the way, you could add missing spaces in lists

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done in 0f7b030


- ``f`` - maximum fill number. This is an optional
- ``f`` -- maximum fill number. This is an optional
Copy link
Contributor

Choose a reason for hiding this comment

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

could use the standard form

- ``f`` -- integer (default: ``None``); specify the maximum fill number.
  By default (``None``), the method uses the number of cells in the shape.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done as part of 873c780

- ``self`` - a polyomino of dimension 3
- ``size`` - number (optional, default: ``1``), the size of each
- ``self`` -- a polyomino of dimension 3
- ``size`` -- number (optional, default: ``1``), the size of each
Copy link
Contributor

Choose a reason for hiding this comment

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

we could remove the term optional. We have it many times for parameters with default value.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've left the "optional" as is, too many changes in this PR already

Copy link

Documentation preview for this PR (built with commit 82266d0; changes) is ready! 🎉

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

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Mar 21, 2024

Thank you!

@vbraun vbraun merged commit 9734dd9 into sagemath:develop Mar 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants