SURGroup / UQpy

UQpy (Uncertainty Quantification with python) is a general purpose Python toolbox for modeling uncertainty in physical and mathematical systems.
MIT License
267 stars 75 forks source link

Feature/documentation improvements #220

Closed connor-krill closed 11 months ago

connor-krill commented 11 months ago

Documentation Improvements

Cleaned up the LaTeX in examples and documentation of FORM. Also reorganized some of the logic for FORM convergence criteria to be more legible, while maintaining logical flow.

Description

Removed duplicate import statements, fixed typos in English and LaTeX in FORM documentation, added failure_probability attribute to documentation, alphabetized attributes, replaced generic variable names with correctly capitalized specific variable names.

Related Issue

Issue #194 noted a duplicate import statement in an example.

Motivation and Context

These changes improve the legibility of the logic flow in FORM and make its documentation more specific and useful.

How Has This Been Tested?

All existing FORM tests for convergence, accuracy, and input/output types are still in place and passed.

Screenshots (if appropriate):

No applicable screenshots.

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

Checklist:

Go over all the following points, and put an x in all the boxes that apply. If you're unsure about any of these, don't hesitate to ask. We're here to help!

sonarcloud[bot] commented 11 months ago

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 2 Code Smells

100.0% 100.0% Coverage
0.0% 0.0% Duplication