Skip to content

Correct two minor problems with io.fits documentation#15185

Merged
pllim merged 2 commits intoastropy:mainfrom
cgobat:doc-corrections
Aug 17, 2023
Merged

Correct two minor problems with io.fits documentation#15185
pllim merged 2 commits intoastropy:mainfrom
cgobat:doc-corrections

Conversation

@cgobat
Copy link
Copy Markdown
Member

@cgobat cgobat commented Aug 17, 2023

Description

This pull request addresses some minor errors in FITS-related documentation:

  • Pairs of backticks and quotation marks in the docstring for _BaseHDU.writeto() were not all closed/consistent, which led to odd/improper formatting when rendered in markdown.
  • np.arange(x) called with no additional arguments creates an array from 0(.0) to x(.0), not x.9.
  • 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.

@cgobat cgobat requested a review from saimn as a code owner August 17, 2023 17:24
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Aug 17, 2023

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?
  • Is a milestone set? Milestone must be set but we cannot check for it on Actions; do not let the green checkmark fool you.
  • 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 v5.0.8 milestone Aug 17, 2023
pllim
pllim approved these changes Aug 17, 2023
View reviewed changes
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.

Good catch, thanks!

@pllim
Copy link
Copy Markdown
Member

pllim commented Aug 17, 2023

I restarted RTD to pick up a new upstream release. 🤞

@pllim
Copy link
Copy Markdown
Member

pllim commented Aug 17, 2023

Oh, great, it is sphinx-gallery now.

@pllim pllim mentioned this pull request Aug 17, 2023
Merged
@pllim
Copy link
Copy Markdown
Member

pllim commented Aug 17, 2023

Anyways, I don't see how your patch can break anything, so merging anyway. RTD failure is unrelated. Thanks!

@pllim pllim merged commit 8b18851 into astropy:main Aug 17, 2023
@meeseeksmachine meeseeksmachine mentioned this pull request Aug 17, 2023
Merged
meeseeksmachine pushed a commit to meeseeksmachine/astropy that referenced this pull request Aug 17, 2023
@pllim @meeseeksmachine
Backport PR astropy#15185: Correct two minor problems with io.fits …
ef268ce 
…documentation
@meeseeksmachine meeseeksmachine mentioned this pull request Aug 17, 2023
Merged
meeseeksmachine pushed a commit to meeseeksmachine/astropy that referenced this pull request Aug 17, 2023
@pllim @meeseeksmachine
Backport PR astropy#15185: Correct two minor problems with io.fits …
7b7b566 
…documentation
@cgobat
Copy link
Copy Markdown
Member Author

cgobat commented Aug 17, 2023

Of course! Thanks for the rapid review and merge!

@pllim
Copy link
Copy Markdown
Member

pllim commented Aug 17, 2023

No worries. Gotta balance out the universe sometimes. Can't have all the PRs sit for a few years. 😉

pllim added a commit that referenced this pull request Aug 17, 2023
@pllim
Merge pull request #15186 from meeseeksmachine/auto-backport-of-pr-15…
5b0f9c8 
…185-on-v5.0.x

Backport PR #15185 on branch v5.0.x (Correct two minor problems with `io.fits` documentation)
pllim added a commit that referenced this pull request Aug 17, 2023
@pllim
Merge pull request #15187 from meeseeksmachine/auto-backport-of-pr-15…
43b5833 
…185-on-v5.3.x

Backport PR #15185 on branch v5.3.x (Correct two minor problems with `io.fits` documentation)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pllim pllim pllim approved these changes

@saimn saimn Awaiting requested review from saimn saimn is a code owner

Assignees

No one assigned

Labels

Bug Docs io.fits no-changelog-entry-needed

Projects

None yet

Milestone

v5.0.8

Development

Successfully merging this pull request may close these issues.

2 participants

@cgobat @pllim