Skip to content

Remove unused EXAMPLE START and EXAMPLE END tags from docs (#18403)#19695

Open
thiagodcoq wants to merge 3 commits into
astropy:mainfrom
thiagodcoq:fix-issue18403
Open

Remove unused EXAMPLE START and EXAMPLE END tags from docs (#18403)#19695
thiagodcoq wants to merge 3 commits into
astropy:mainfrom
thiagodcoq:fix-issue18403

Conversation

@thiagodcoq
Copy link
Copy Markdown

@thiagodcoq thiagodcoq commented May 6, 2026 •
edited by dhomeier
Loading

Description

This PR removes the unused EXAMPLE START and EXAMPLE END tags from the documentation files as requested

This pull request is to address ...

Fixes #18403

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

@thiagodcoq thiagodcoq requested a review from nstarman May 7, 2026 00:00
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2026

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.

@dhomeier dhomeier requested a review from pllim May 7, 2026 00:27
taldcroft
taldcroft approved these changes May 7, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@taldcroft taldcroft left a comment

Choose a reason for hiding this comment

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

These changes look fine to me.

@github-project-automation github-project-automation Bot moved this from Triage to Reviewer approved in Cosmology, the Expansion May 7, 2026
@thiagodcoq
Copy link
Copy Markdown
Author

thiagodcoq commented May 7, 2026

pre-commit.ci autofix

dhomeier
dhomeier requested changes May 7, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@dhomeier dhomeier left a comment

Choose a reason for hiding this comment

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

Thanks for taking this on. The changes in io.ascii look ok for me, but it seems there are others that remove tags which are actually used. This probably needs a second pass to filter the really unused tags.
Also could you verify that you followed the guidelines on rebasing? Commits like 3a11fdc should not normally appear in a PR branch.

Comment thread docs/cosmology/io/index.rst
Astropy's Cosmology I/O, ``to/from_format`` can be used to convert cosmology
instances between packages!

.. EXAMPLE START: Planck18 to QTable and back
Copy link
Copy Markdown
Contributor

@dhomeier dhomeier May 7, 2026

Choose a reason for hiding this comment

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

This change has already been flagged as invalid in #19290; looks like the one in custom.rst above also pertains to an existing example.

@github-project-automation github-project-automation Bot moved this from Reviewer approved to Review in progress in Cosmology, the Expansion May 7, 2026
@pllim pllim added this to the v8.1.0 milestone May 7, 2026
@pllim
Copy link
Copy Markdown
Member

pllim commented May 7, 2026

I thought @astropy/learn-astropy-team was gonna see if they would want to keep these or not. Did they ever make a decision?

@dhomeier
Copy link
Copy Markdown
Contributor

dhomeier commented May 7, 2026

At a minimum this will need some guidance how to identify unused vs. used tags. Can anything having a title or description be considered “in use”?

@astrofrog
Copy link
Copy Markdown
Member

astrofrog commented May 8, 2026

@pllim - from what I can see there hasn't been a decision on astropy learn

@thiagodcoq
Copy link
Copy Markdown
Author

thiagodcoq commented May 9, 2026

Hey, thanks for the feedback, I'll look into the requested changes and make a new commit

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dhomeier dhomeier dhomeier requested changes

@taldcroft taldcroft taldcroft approved these changes

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

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

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

@nstarman nstarman Awaiting requested review from nstarman nstarman is a code owner automatically assigned from astropy/cosmology

@pllim pllim Awaiting requested review from pllim

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

config constants convolution coordinates cosmology Docs io.ascii io.fits io.registry io.votable nddata no-changelog-entry-needed samp stats table time timeseries uncertainty units

Projects

Cosmology, the Expansion
Status: Review in progress

Milestone

v8.1.0

Development

Successfully merging this pull request may close these issues.

Will Learn use EXAMPLE START/END or should we remove them?

5 participants

@thiagodcoq @pllim @dhomeier @astrofrog @taldcroft