docs(src): add docstrings to training utils env module#131
Merged
WilliamBerryiii merged 2 commits intomainfrom Feb 7, 2026
Merged
docs(src): add docstrings to training utils env module#131WilliamBerryiii merged 2 commits intomainfrom
WilliamBerryiii merged 2 commits intomainfrom
Conversation
- expand require_env docstring with Args, Returns, Raises sections - expand set_env_defaults docstring with Args and preservation semantics - document empty-string edge case in require_env - use collections.abc.Mapping for Python 3.11+ alignment - align docstring spacing with metrics.py reference convention 📝 - Generated by Copilot
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
There was a problem hiding this comment.
Pull request overview
This PR expands Google-style docstrings for the two public utility functions in src/training/utils/env.py to meet OpenSSF documentation requirements. The changes add comprehensive Args, Returns, and Raises sections while documenting important edge cases (empty-string handling in require_env and preservation semantics in set_env_defaults). Additionally, the Mapping import is modernized from typing to collections.abc for Python 3.11+ alignment.
Changes:
- Expanded docstrings for
require_envandset_env_defaultsfunctions with full Google-style sections - Updated
Mappingimport fromtypingtocollections.abcfor Python 3.9+ compatibility
WilliamBerryiii
changed the title
agreaves-ms
approved these changes
Feb 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Expand Google-style docstrings for both functions in
src/training/utils/env.pywithArgs,Returns, andRaisessections. Documents the empty-string edge case inrequire_envand preservation semantics inset_env_defaults. Updates theMappingimport tocollections.abcfor Python 3.11+ alignment.Closes #72
Type of Change
Component(s) Affected
deploy/000-prerequisites- Azure subscription setupdeploy/001-iac- Terraform infrastructuredeploy/002-setup- OSMO control plane / Helmdeploy/004-workflow- Training workflowssrc/training- Python training scriptsdocs/- DocumentationTesting Performed
planreviewed (no unexpected changes)applytested in dev environmentsmoke_test_azure.py)Checklist