Skip to content

Add documentation to residual_decorrelation module#136

Merged
ammarcsj merged 1 commit into
add_quant_reader_and_table_updatesfrom
document_residual_decorrelation
May 25, 2026
Merged

Add documentation to residual_decorrelation module#136
ammarcsj merged 1 commit into
add_quant_reader_and_table_updatesfrom
document_residual_decorrelation

Conversation

@ammarcsj
Copy link
Copy Markdown
Member

Summary

  • Adds module-level docstring with algorithm overview and structure index
  • Adds docstrings to all public functions and data classes
  • Adds inline comments at logical units in every function explaining the why

Notes

Final PR in the residual decorrelation stack. Stacked on #135.

Base automatically changed from wire_new_aggregation_features to add_quant_reader_and_table_updates May 25, 2026 09:11
@ammarcsj ammarcsj merged commit a3aa371 into add_quant_reader_and_table_updates May 25, 2026
3 of 4 checks passed
@ammarcsj ammarcsj deleted the document_residual_decorrelation branch May 25, 2026 09:11
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