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

Remove Invalid Escape Sequences #1741

Merged
merged 4 commits into from
Jan 18, 2022
Merged

Conversation

dylanjm
Copy link
Collaborator

@dylanjm dylanjm commented Jan 10, 2022


Pull Request Description

What issue does this change request address? (Use "#" before the issue to link it, i.e., #42.)

close #1740

What are the significant changes in functionality due to this change request?

This PR fixes a deprecation defect by utilizing raw-strings for RAVEN docstrings that contain LaTeX equations and other escape sequences.

It also removes deprecated disutils.version. So warnings stemming from that should cease as well.


For Change Control Board: Change Request Review

The following review must be completed by an authorized member of the Change Control Board.

  • 1. Review all computer code.
  • 2. If any changes occur to the input syntax, there must be an accompanying change to the user manual and xsd schema. If the input syntax change deprecates existing input files, a conversion script needs to be added (see Conversion Scripts).
  • 3. Make sure the Python code and commenting standards are respected (camelBack, etc.) - See on the wiki for details.
  • 4. Automated Tests should pass, including run_tests, pylint, manual building and xsd tests. If there are changes to Simulation.py or JobHandler.py the qsub tests must pass.
  • 5. If significant functionality is added, there must be tests added to check this. Tests should cover all possible options. Multiple short tests are preferred over one large test. If new development on the internal JobHandler parallel system is performed, a cluster test must be added setting, in XML block, the node <internalParallel> to True.
  • 6. If the change modifies or adds a requirement or a requirement based test case, the Change Control Board's Chair or designee also needs to approve the change. The requirements and the requirements test shall be in sync.
  • 7. The merge request must reference an issue. If the issue is closed, the issue close checklist shall be done.
  • 8. If an analytic test is changed/added is the the analytic documentation updated/added?
  • 9. If any test used as a basis for documentation examples (currently found in raven/tests/framework/user_guide and raven/docs/workshop) have been changed, the associated documentation must be reviewed and assured the text matches the example.

@dylanjm dylanjm requested a review from wangcj05 January 10, 2022 18:18
@moosebuild
Copy link

Job Mingw Test on 6024ce9 : invalidated by @joshua-cogliati-inl

failed in fetch

@moosebuild
Copy link

Job Test qsubs sawtooth on 6024ce9 : invalidated by @wangcj05

rerun

Copy link
Collaborator

@wangcj05 wangcj05 left a comment

Choose a reason for hiding this comment

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

Changes are good.

@wangcj05
Copy link
Collaborator

PR is good, checklist is satisfied. PR can be merged.

@wangcj05 wangcj05 merged commit 1771bc0 into idaholab:devel Jan 18, 2022
@dylanjm dylanjm deleted the escape-seq-fix branch January 30, 2023 18:50
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.

[DEFECT] Remove invalid escape sequence deprecation warnings.
4 participants