Skip to content

MAINT: Let ruff format run on docs and examples#16132

Merged
pllim merged 2 commits into
astropy:mainfrom
MridulS:format_docs_examples
Feb 29, 2024
Merged

MAINT: Let ruff format run on docs and examples#16132
pllim merged 2 commits into
astropy:mainfrom
MridulS:format_docs_examples

Conversation

@MridulS
Copy link
Copy Markdown
Contributor

@MridulS MridulS commented Feb 29, 2024

As mentioned in #16029 (review) this turns on code formatting for docs/ and examples/.

  • By checking this box, the PR author has requested that maintainers do NOT use the "Squash and Merge" button. Maintainers should respect this when possible; however, the final decision is at the discretion of the maintainer that merges the PR.

@github-actions
Copy link
Copy Markdown
Contributor

Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.

  • Do the proposed changes actually accomplish desired goals?
  • Do the proposed changes follow the Astropy coding guidelines?
  • Are tests added/updated as required? If so, do they follow the Astropy testing guidelines?
  • Are docs added/updated as required? If so, do they follow the Astropy documentation guidelines?
  • Is rebase and/or squash necessary? If so, please provide the author with appropriate instructions. Also see instructions for rebase and squash.
  • Did the CI pass? If no, are the failures related? If you need to run daily and weekly cron jobs as part of the PR, please apply the "Extra CI" label. Codestyle issues can be fixed by the bot.
  • Is a change log needed? If yes, did the change log check pass? If no, add the "no-changelog-entry-needed" label. If this is a manual backport, use the "skip-changelog-checks" label unless special changelog handling is necessary.
  • Is this a big PR that makes a "What's new?" entry worthwhile and if so, is (1) a "what's new" entry included in this PR and (2) the "whatsnew-needed" label applied?
  • At the time of adding the milestone, if the milestone set requires a backport to release branch(es), apply the appropriate "backport-X.Y.x" label(s) before merge.

@pllim pllim added this to the v6.1.0 milestone Feb 29, 2024
Copy link
Copy Markdown
Member

@pllim pllim left a comment

Choose a reason for hiding this comment

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

I thought ruff would annoy me but I think I like the readability improvement here in the user examples. Thanks!

@pllim pllim merged commit 73df592 into astropy:main Feb 29, 2024
@mcara
Copy link
Copy Markdown
Contributor

mcara commented Feb 29, 2024

I thought ruff would annoy me but I think I like the readability improvement here in the user examples. Thanks!

I don't think I am as disappointed with ruff as @pllim is.

d-giles referenced this pull request in d-giles/astropy-abdufork Jul 26, 2024
* MAINT: Let ruff format run on docs and examples
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