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

Fix comment on ginac NegInfinity constant #39138

Merged
merged 4 commits into from
Jan 27, 2025

Conversation

DaveWitteMorris
Copy link
Member

The comment on ginac's NegInfinity constant (lines 374-375 of src/sage/symbolic/ginac/infinity.cpp is a duplicate of the comment on Infinity:

/** Infinity, i.e., positive infinity.
 *  Calls python function py_eval_infinity for evalf(). */
const infinity Infinity = infinity::from_sign(+1);


/** Infinity, i.e., positive infinity.
 *  Calls python function py_eval_infinity for evalf(). */
const infinity NegInfinity = infinity::from_sign(-1);

That is not correct for NegInfinity, so this PR changes the comment for NegInfinity to:

/** NegInfinity, i.e., negative infinity.
 *  Calls python function py_eval_neg_infinity for evalf(). */

📝 Checklist

  • The title is concise and informative.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation and checked the documentation preview.

⌛ Dependencies

Copy link

github-actions bot commented Dec 16, 2024

Documentation preview for this PR (built with commit a070310; changes) is ready! 🎉
This preview will update shortly after each push to this PR.

Copy link
Collaborator

@kwankyu kwankyu left a comment

Choose a reason for hiding this comment

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

LGTM.

@DaveWitteMorris
Copy link
Member Author

Thanks!

vbraun pushed a commit to vbraun/sage that referenced this pull request Jan 25, 2025
    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

The comment on ginac's `NegInfinity` constant (lines 374-375 of
`src/sage/symbolic/ginac/infinity.cpp` is a duplicate of the comment on
`Infinity`:
```
/** Infinity, i.e., positive infinity.
 *  Calls python function py_eval_infinity for evalf(). */
const infinity Infinity = infinity::from_sign(+1);


/** Infinity, i.e., positive infinity.
 *  Calls python function py_eval_infinity for evalf(). */
const infinity NegInfinity = infinity::from_sign(-1);
```
That is not correct for `NegInfinity`, so this PR changes the comment
for `NegInfinity` to:
```
/** NegInfinity, i.e., negative infinity.
 *  Calls python function py_eval_neg_infinity for evalf(). */
```
### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#39138
Reported by: DaveWitteMorris
Reviewer(s): Kwankyu Lee
@vbraun vbraun merged commit eb22c86 into sagemath:develop Jan 27, 2025
21 of 22 checks passed
@DaveWitteMorris DaveWitteMorris deleted the NegInfinity branch January 27, 2025 00:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants