Skip to content

BUG: ensure that docstrings in classes from astropy.io.ascii are always available for inspection at runtime - #17556

Closed
neutrinoceros wants to merge 1 commit into
astropy:mainfrom
neutrinoceros:io.ascii/bug/compat_optimized_mode
Closed

neutrinoceros wants to merge 1 commit into
astropy:mainfrom
neutrinoceros:io.ascii/bug/compat_optimized_mode

Conversation

@neutrinoceros

Copy link
Copy Markdown
Contributor

Description

ref #17472

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

@neutrinoceros neutrinoceros changed the title BUG: ensure that docstrings in classes from astropy.io.ascii are always available for inspection at runtime BUG: ensure that docstrings in classes from astropy.io.ascii are always available for inspection at runtime Dec 18, 2024
@taldcroft

Copy link
Copy Markdown
Member

I don't quite understand why only the classes in basic.py get the __doc__ = change. What about all the other Reader classes? https://astropy--17556.org.readthedocs.build/en/17556/io/ascii/ref_api.html#classes

@neutrinoceros

Copy link
Copy Markdown
Contributor Author

That's just because I lack a systematic way to look for child classes. This table will do, thanks !

@neutrinoceros
neutrinoceros marked this pull request as draft December 18, 2024 12:49
@neutrinoceros
neutrinoceros force-pushed the io.ascii/bug/compat_optimized_mode branch from 8ebbb8a to 98f6fc5 Compare December 18, 2024 12:57
@neutrinoceros
neutrinoceros marked this pull request as ready for review December 18, 2024 12:57
@neutrinoceros

Copy link
Copy Markdown
Contributor Author

Closing this following discussion over at #17555

@neutrinoceros
neutrinoceros deleted the io.ascii/bug/compat_optimized_mode branch December 20, 2024 10:54
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.

2 participants