Skip to content

Auto update of doc strings - #84

Merged
dgilford merged 1 commit into
masterfrom
docstrings_cleanup
Jan 13, 2026
Merged

dgilford merged 1 commit into
masterfrom
docstrings_cleanup

Conversation

@dgilford

Copy link
Copy Markdown
Owner

This pull request focuses on improving the documentation for several core functions in the codebase by converting their docstrings to the NumPy/SciPy style. This enhances clarity and consistency, making the code easier to understand and maintain, especially for new contributors. No functional changes to the code logic were introduced.

Documentation improvements:

  • Updated docstrings for all functions in src/tcpyPI/utilities.py to use the NumPy/SciPy documentation style, including clear sections for Parameters, Returns, and Examples. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13]
  • Converted docstrings for key scientific computation functions in src/tcpyPI/pi.py (cape, solve_temperature_from_entropy, pi) to the NumPy/SciPy style, improving parameter explanations and return value descriptions. [1] [2] [3]
  • Enhanced docstrings for sample dataset functions in run_sample.py to provide detailed parameter and return value documentation in the NumPy/SciPy format. [1] [2]

@dgilford
dgilford merged commit b7de1f3 into master Jan 13, 2026
5 checks passed
@dgilford
dgilford deleted the docstrings_cleanup branch January 13, 2026 17:16
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.

1 participant