Skip to content

Fix references to file-like objects in glossary#15715

Merged
pllim merged 1 commit into
astropy:mainfrom
eerovaher:fix-file-like-ref
Dec 11, 2023
Merged

Fix references to file-like objects in glossary#15715
pllim merged 1 commit into
astropy:mainfrom
eerovaher:fix-file-like-ref

Conversation

@eerovaher
Copy link
Copy Markdown
Member

@eerovaher eerovaher commented Dec 11, 2023

Description

In 0ffdbb2 the glossary was sorted alphabetically. The "writable file-like object" and "readable file-like object" entries were renamed so that they would be next to each other, but that broke some references to the old entries in some of the docstrings.

Note that #15705 was milestoned for 6.0.1, but despite that it was not backported, so I've milestoned this pull request for 6.1.0.

  • 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.

@eerovaher eerovaher added this to the v6.1.0 milestone Dec 11, 2023
@eerovaher eerovaher requested a review from taldcroft December 11, 2023 16:36
@github-actions
Copy link
Copy Markdown
Contributor

ghost commented Dec 11, 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 approved these changes Dec 11, 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.

Thanks! I was wondering why RTD is failing on latest. How was this not caught in the original PR?

@pllim
Copy link
Copy Markdown
Member

pllim commented Dec 11, 2023

Thanks for pointing out about the milestone/backport inconsistency. I changed the original PR milestone to be the same as this one. If someone really wants to backport the original changes, they need to manually backport both this and that other PR at the same time.

@eerovaher
Copy link
Copy Markdown
Member Author

eerovaher commented Dec 11, 2023

I can't give a very detailed explanation, but if a link target is deleted but something is still linking to it then apparently that goes entirely unnoticed in the pull request and only becomes a problem after the pull request has been merged. I managed to break the documentation build in a very similar manner just last week.

@pllim
Copy link
Copy Markdown
Member

pllim commented Dec 11, 2023

Ah, yeah, we have some weird setup in docs/conf.py, so maybe...

astropy/docs/conf.py

Line 108 in 034d055

"astropy-dev": ("https://docs.astropy.org/en/latest/", None),

🤷

@eerovaher
Fix references to file-like objects in glossary
0267269 
In 0ffdbb2 (Improve astropy glossary)
the glossary was sorted alphabetically. The "writable file-like object"
and "readable file-like object" entries were renamed so that they would
be next to each other, but that broke some references to the old entries
in a few docstrings. [ci skip]
@pllim pllim merged commit 2f29cfd into astropy:main Dec 11, 2023
@taldcroft
Copy link
Copy Markdown
Member

taldcroft commented Dec 11, 2023

Thanks for the fix! I didn't realize things could break like this.

@eerovaher eerovaher deleted the fix-file-like-ref branch December 11, 2023 20:45
@eerovaher eerovaher mentioned this pull request May 22, 2024
Closed
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

@taldcroft taldcroft Awaiting requested review from taldcroft

Assignees

No one assigned

Labels

Docs 🔥 Critical io.votable no-changelog-entry-needed utils

Projects

None yet

Milestone

v6.1.0

Development

Successfully merging this pull request may close these issues.

3 participants

@eerovaher @pllim @taldcroft