Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: known issue about pandas Series multiplication #15904

Merged
merged 8 commits into from
Feb 16, 2024

Conversation

MridulS
Copy link
Contributor

@MridulS MridulS commented Jan 17, 2024

Description

This PR adds a section to https://docs.astropy.org/en/latest/known_issues.html regarding the fragile behavior with pd.Series objects.

Fixes #11247

  • 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 github-actions bot added the Docs label Jan 17, 2024
Copy link

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.

@MridulS
Copy link
Contributor Author

MridulS commented Jan 17, 2024

Hmm, this is failing as pandas isn't installed in the minimal dependencies environment and in the olddeps environment it fails with pandas 1.4.

Copy link
Contributor

@mhvk mhvk left a comment

Choose a reason for hiding this comment

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

On the test failure, there is

.. doctest-requires:: pandas

but I'm not sure we can give this a minimum version.

To be honest, I'm fine with just skipping the tests...

docs/known_issues.rst Show resolved Hide resolved
docs/known_issues.rst Outdated Show resolved Hide resolved
docs/known_issues.rst Outdated Show resolved Hide resolved
docs/known_issues.rst Outdated Show resolved Hide resolved
docs/known_issues.rst Outdated Show resolved Hide resolved
docs/known_issues.rst Outdated Show resolved Hide resolved
docs/known_issues.rst Outdated Show resolved Hide resolved
docs/known_issues.rst Outdated Show resolved Hide resolved
MridulS and others added 2 commits February 12, 2024 18:30
Co-authored-by: Eero Vaher <eero.vaher@gmail.com>
docs/known_issues.rst Outdated Show resolved Hide resolved
docs/known_issues.rst Outdated Show resolved Hide resolved
@pllim pllim added this to the v6.0.1 milestone Feb 12, 2024
@pllim pllim added 💤 backport-v6.0.x on-merge: backport to v6.0.x units labels Feb 12, 2024
Copy link
Contributor

@mhvk mhvk left a comment

Choose a reason for hiding this comment

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

Thanks, @MridulS! Looks all good to me, but I'll let @eerovaher have a last look too.

docs/known_issues.rst Outdated Show resolved Hide resolved
Co-authored-by: Eero Vaher <eero.vaher@gmail.com>
@eerovaher
Copy link
Member

This is almost ready, but there's a trailing whitespace somewhere that is causing the pre-commit.ci job to fail.

@pllim
Copy link
Member

pllim commented Feb 14, 2024

pre-commit.ci autofix

@pllim
Copy link
Member

pllim commented Feb 14, 2024

@eerovaher , the bot took care of the trailing whitespace. Does this look good to you now? We can always use the squash and merge button for this PR.

Thanks, all!

docs/known_issues.rst Outdated Show resolved Hide resolved
@eerovaher eerovaher merged commit e0f6be7 into astropy:main Feb 16, 2024
25 of 26 checks passed
meeseeksmachine pushed a commit to meeseeksmachine/astropy that referenced this pull request Feb 16, 2024
eerovaher added a commit that referenced this pull request Feb 16, 2024
…904-on-v6.0.x

Backport PR #15904 on branch v6.0.x (DOC: known issue about pandas Series multiplication)
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.

Quantity objects should accept pandas Series
4 participants