README/docstring convention cleanup - #55
Merged
Merged
Conversation
Three spots described how the file/toolkit got to its current state (CI confirmation, an issue number, a prior implementation detail, an internal spec section reference) rather than just the current user-facing fact. Also drops the Communications Toolbox mention entirely (a toolbox that isn't used doesn't need a line explaining that).
- README.md: convert ~208 inline code spans from triple backticks to standard single backticks, matching CONTRIBUTING.md/SECURITY.md/ CLAUDE.md/RELEASE_NOTES.md's convention. Fenced code blocks (the repository-layout tree, MATLAB examples) untouched. - core/PYTHIA.m: add the structured Inputs/Outputs docstring section its core/ siblings (PRELIM, SIFTED, PILOT, CLOISTER, TRACE, FILTER, INIT) all have; it was the one core pipeline file still documented as free narrative prose instead. - output/scriptpng.m, example.m: normalize internal section-divider comment lines to the same 73-dash width used everywhere else (some were 69 or 71 dashes). liveDemoIS.m's inline (pre-header) citation is left as-is, by request.
andremun
changed the title
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.
Summary
Two rounds of documentation-convention cleanup, both docs-only:
core/PYTHIA.mwas the onecore/pipeline file still documented as free narrative prose instead of the structured Inputs/Outputs section its siblings (PRELIM, SIFTED, PILOT, CLOISTER, TRACE, FILTER, INIT) all have. Added.output/scriptpng.mandexample.mused 69/71 dashes instead of the 73-dash width used everywhere else. Normalized.liveDemoIS.m's citation (in prose before its license header rather than in the standard% Reference:block) was checked and left as-is, by request.No code behaviour changes anywhere in this PR.
Test plan