Skip to content

Python usage documentation#124

Open
zack-rma wants to merge 2 commits intomainfrom
docs/python
Open

Python usage documentation#124
zack-rma wants to merge 2 commits intomainfrom
docs/python

Conversation

@zack-rma
Copy link
Contributor

@zack-rma zack-rma commented Mar 7, 2026

Notes for Reviewers

Please consider the following when reviewing this PR:

  • Correctness: Does the code do what it claims? Are edge cases handled appropriately?
  • Clarity: Is the code readable, maintainable and aligned with SOLID design principles?
  • Impact: Will this change affect other parts of the system? Any potential regressions?
  • Testing: Are the test cases sufficient and appropriate? Are there gaps in coverage?
  • Documentation: Does this require updates to code comments, README, or other docs?

Description

Adds documentation for current usages of Python within WRIMS-GUI.

Motivation and Context

Addresses CentralValleyModeling/wrims-engine#206

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation change
  • New tests (new unit tests, test scenarios, or test case documentation)
  • Triggers regression testing (change affects downstream modules and will require regression testing)
  • Other (include a description)

@zack-rma zack-rma added the documentation Improvements or additions to documentation label Mar 7, 2026
@zack-rma zack-rma marked this pull request as ready for review March 9, 2026 20:48
@zack-rma zack-rma requested a review from rma-psmorris March 9, 2026 20:48
@zack-rma zack-rma moved this to Needs Review in WRIMS 3 Development Mar 9, 2026
@sonarqubecloud
Copy link

sonarqubecloud bot commented Mar 9, 2026

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Needs Review

Development

Successfully merging this pull request may close these issues.

2 participants