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

SyntaxWarnings when running a snippet from the README.md #8

Open
dilawar opened this issue Jan 11, 2025 · 2 comments
Open

SyntaxWarnings when running a snippet from the README.md #8

dilawar opened this issue Jan 11, 2025 · 2 comments

Comments

@dilawar
Copy link

dilawar commented Jan 11, 2025

I ran the following snippet https://github.com/dilawar/joss-review-7618-ratesb-python/blob/674ad72e64fd11505a8809d45a7b0b412b748b83/review_ratesb_python/sanity_checks.py

I got the following warnings. I am on Windows + Python 3.12

uv run -s sanity_checks.py
C:\tools\msys64\home\dilaw\Work\GITHUB\joss-review-7618-ratesb-python\review_ratesb_python\.venv\Lib\site-packages\SBMLKinetics\kinetics_output.py:453: SyntaxWarning: invalid escape sequence '\p'
  """
C:\tools\msys64\home\dilaw\Work\GITHUB\joss-review-7618-ratesb-python\review_ratesb_python\.venv\Lib\site-packages\SBMLKinetics\kinetics_output.py:483: SyntaxWarning: invalid escape sequence '\p'
  """
C:\tools\msys64\home\dilaw\Work\GITHUB\joss-review-7618-ratesb-python\review_ratesb_python\.venv\Lib\site-packages\SBMLKinetics\kinetics_output.py:553: SyntaxWarning: invalid escape sequence '\p'
  """
C:\tools\msys64\home\dilaw\Work\GITHUB\joss-review-7618-ratesb-python\review_ratesb_python\.venv\Lib\site-packages\SBMLKinetics\kinetics_output.py:613: SyntaxWarning: invalid escape sequence '\p'
  """
C:\tools\msys64\home\dilaw\Work\GITHUB\joss-review-7618-ratesb-python\review_ratesb_python\.venv\Lib\site-packages\SBMLKinetics\kinetics_output.py:647: SyntaxWarning: invalid escape sequence '\p'
  """
C:\tools\msys64\home\dilaw\Work\GITHUB\joss-review-7618-ratesb-python\review_ratesb_python\.venv\Lib\site-packages\SBMLKinetics\kinetics_output.py:680: SyntaxWarning: invalid escape sequence '\p'
  """
C:\tools\msys64\home\dilaw\Work\GITHUB\joss-review-7618-ratesb-python\review_ratesb_python\.venv\Lib\site-packages\SBMLKinetics\kinetics_output.py:702: SyntaxWarning: invalid escape sequence '\p'
  """
C:\tools\msys64\home\dilaw\Work\GITHUB\joss-review-7618-ratesb-python\review_ratesb_python\.venv\Lib\site-packages\SBMLKinetics\kinetics_output.py:731: SyntaxWarning: invalid escape sequence '\p'
  """
C:\tools\msys64\home\dilaw\Work\GITHUB\joss-review-7618-ratesb-python\review_ratesb_python\.venv\Lib\site-packages\SBMLKinetics\kinetics_output.py:753: SyntaxWarning: invalid escape sequence '\p'
  """
_J0:
  Warning 1004: Flux is not decreasing as product increases.

If these SyntaxWarning can not be fixed for some reason then it should be mentioned in docs.

@dilawar dilawar changed the title Warnings when running basic snippets SyntaxWarnings when running basic snippets Jan 11, 2025
@dilawar dilawar changed the title SyntaxWarnings when running basic snippets SyntaxWarnings when running a snippet from the README.md Jan 11, 2025
@dilawar
Copy link
Author

dilawar commented Jan 11, 2025

A minor nitpick, feel free to ignore:

The last warning -- _J0: Warning 1004: Flux is not decreasing as product increases. can be confusing to user who didn't read the docs properly. Perhaps you can add a Learn more which links to official docs if any warning is emitted by the program?

@RMeli
Copy link

RMeli commented Jan 13, 2025

JOSS review: openjournals/joss-reviews#7618

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

No branches or pull requests

2 participants