docs: close documentation gaps in example source files - #11
Merged
Merged
Conversation
Audited all example source files against the repo's teaching-doc standard
(file-header purpose/run/deps/assumptions + what/why + security note). Six
fell short; fixed with comment-only changes (no behaviour change):
- Enhanced_Check/FundsXML_CompleteDQReport_HTML.xsl: add the missing file
header (purpose, run command, why XSLT 1.0, deps, FundsXML no-namespace +
UniqueID-key rationale + tolerance sync note) — it was the only example
with no header at all.
- XSLT_Transformations/invocation/RunTransform.java,
XQuery_Examples/invocation/RunXQuery.java: add explicit Dependencies line
and note they are generic FundsXML-agnostic invocation wrappers.
- Large_File_Processing/python/{stream_aggregate,split,delta_diff}.py: add
explicit Dependencies + Security lines (the iterparse calls were already
XXE-hardened; now documented).
The other ~35 example files were audited and already meet the standard.
Verified: Enhanced report still renders; the Python files compile & run.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Documentation-only. Audited all 41 example source files against the repo's teaching-doc standard (file-header purpose/run/deps/FundsXML assumptions + what/why comments + security note where XML is parsed). 35 already met it; the 6 below were brought up to standard with comment-only edits — no behavioural change.
XSLT_DataQuality_Checks/Enhanced_Check/FundsXML_CompleteDQReport_HTML.xslUniqueIDkey rationale + tolerance-sync note.XSLT_Transformations/invocation/RunTransform.javaXQuery_Examples/invocation/RunXQuery.javaLarge_File_Processing/python/stream_aggregate.pyLarge_File_Processing/python/split.pyLarge_File_Processing/python/delta_diff.pyVerified: the Enhanced report still renders (39 KB HTML) and the three Python files compile and run unchanged.
🤖 Generated with Claude Code