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.

Sign up for GitHub

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

Jump to bottom

Modify example format for the rattle methods in md #1601

Merged
merged 1 commit into from Aug 9, 2023
Merged

Modify example format for the rattle methods in md #1601

merged 1 commit into from Aug 9, 2023

Conversation

melodyyzh
Copy link
Contributor

Description

This PR continues from #1596
Formatted the code examples in the doc strings for 2 additional classes in rattle.py

Motivation and context

Continues from #1596

How has this been tested?

Tested rattle.py and test_methods.py using pytest

Change log

Updated the formatting of code examples in `NVE` class and `DisplacementCapped` class for making the example code visible to the user.

Checklist:

@melodyyzh melodyyzh force-pushed the modify_rattle_example_format branch from a01efc6 to ab6eda8 Compare August 9, 2023 04:38
@melodyyzh melodyyzh added the validate Execute long running validation tests on pull requests label Aug 9, 2023
@melodyyzh melodyyzh marked this pull request as ready for review August 9, 2023 05:05
@melodyyzh melodyyzh requested review from a team as code owners August 9, 2023 05:05
@melodyyzh melodyyzh requested review from joaander and rayasare and removed request for a team August 9, 2023 05:05
joaander
joaander approved these changes Aug 9, 2023
View reviewed changes
Copy link
Member

@joaander joaander left a comment

Choose a reason for hiding this comment

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

Thanks!

@joaander joaander merged commit 237d8fb into trunk-minor Aug 9, 2023
72 of 73 checks passed
@joaander joaander deleted the modify_rattle_example_format branch August 9, 2023 14:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joaander joaander joaander approved these changes

@rayasare rayasare rayasare approved these changes

Assignees
No one assigned
Labels
validate Execute long running validation tests on pull requests
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@melodyyzh @joaander @rayasare