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

Copy link

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

Copy link
Contributor

@fchapoton fchapoton left a comment

Choose a reason for hiding this comment

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

really not useful at all, but ok

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Mar 15, 2024

Thanks.

I have to disagree though: The code snippets in our documentation are the most visible part of our source code. It is important that we use a coding style there that follows standard practices, so that it is recognizable to viewers as contemporary Python. And the reformatting of output to fit in the margins and to expose the structure rather than obscuring structure addresses a major usability issue.

@vbraun vbraun merged commit edeb26c 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