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

Improve warning message of Point.vel #25708

Merged
merged 2 commits into from Sep 20, 2023

Conversation

tjstienstra
Copy link
Contributor

References to other Issues or PRs

Brief description of what is fixed or changed

This PR improves the warning message of Point.vel.

Other comments

Release Notes

  • physics.mechanics
    • Improve Point.vel warning message.

@sympy-bot
Copy link

sympy-bot commented Sep 20, 2023

Hi, I am the SymPy bot. I'm here to help you write a release notes entry. Please read the guide on how to write release notes.

Your release notes are in good order.

Here is what the release notes will look like:

This will be added to https://github.com/sympy/sympy/wiki/Release-Notes-for-1.13.

Click here to see the pull request description that was parsed.
<!-- Your title above should be a short description of what
was changed. Do not include the issue number in the title. -->

#### References to other Issues or PRs
<!-- If this pull request fixes an issue, write "Fixes #NNNN" in that exact
format, e.g. "Fixes #1234" (see
https://tinyurl.com/auto-closing for more information). Also, please
write a comment on that issue linking back to this pull request once it is
open. -->


#### Brief description of what is fixed or changed
This PR improves the warning message of `Point.vel`.

#### Other comments


#### Release Notes

<!-- Write the release notes for this release below between the BEGIN and END
statements. The basic format is a bulleted list with the name of the subpackage
and the release note for this PR. For example:

* solvers
  * Added a new solver for logarithmic equations.

* functions
  * Fixed a bug with log of integers. Formerly, `log(-x)` incorrectly gave `-log(x)`.

* physics.units
  * Corrected a semantical error in the conversion between volt and statvolt which
    reported the volt as being larger than the statvolt.

or if no release note(s) should be included use:

NO ENTRY

See https://github.com/sympy/sympy/wiki/Writing-Release-Notes for more
information on how to write release notes. The bot will check your release
notes automatically to see if they are formatted correctly. -->

<!-- BEGIN RELEASE NOTES -->
* physics.mechanics
  * Improve `Point.vel` warning message.
<!-- END RELEASE NOTES -->

Update

The release notes on the wiki have been updated.

@tjstienstra
Copy link
Contributor Author

This is just a frequent message I get when running KanesMethod. By also printing the name of the point for which the warning is given it is easier to specify the velocity manually to prevent the warning.

Comment on lines 574 to 578
warn(f"Velocity of {self.name} automatically calculated based "
f"on point {candidate_neighbor[0].name} but it is also "
f"possible from points(s): {str(candidate_neighbor[1:])}. "
f"Velocities from these points are not necessarily the "
f"same. This may cause errors in your calculations.")
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
warn(f"Velocity of {self.name} automatically calculated based "
f"on point {candidate_neighbor[0].name} but it is also "
f"possible from points(s): {str(candidate_neighbor[1:])}. "
f"Velocities from these points are not necessarily the "
f"same. This may cause errors in your calculations.")
warn(filldedent(f"""
Velocity of {self.name} automatically calculated based
on point {candidate_neighbor[0].name} but it is also
possible from points(s): {str(candidate_neighbor[1:])}.
Velocities from these points are not necessarily the
same. This may cause errors in your calculations."""))

Copy link
Member

Choose a reason for hiding this comment

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

filldedent can be imported from sympy.utilities.misc

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the hint. Adjusted it accordingly in 8dd3feb.

@smichr smichr merged commit 8826e32 into sympy:master Sep 20, 2023
58 of 59 checks passed
@tjstienstra tjstienstra deleted the vel-warning-improvement branch March 28, 2024 21:12
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.

None yet

3 participants