Improve documentation, comment uniformity, and test coverage#74
Draft
Improve documentation, comment uniformity, and test coverage#74
Conversation
…dd READMEs Co-authored-by: bfeitknecht <114588139+bfeitknecht@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Improve documentation and testing
Improve documentation, comment uniformity, and test coverage
Mar 13, 2026
Owner
|
@copilot Also add a README to |
Co-authored-by: bfeitknecht <114588139+bfeitknecht@users.noreply.github.com>
Contributor
Author
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.
Addresses the open items from the documentation and testing issue: uniform inline comments, extended metacommand test coverage, and subdirectory READMEs.
Comment uniformity
singla→singleand missing period inIMP/Lexer.hsREPL/State.hs-- INFO:/-- CHECK:comment bodies consistently across the codebase (14 occurrences)REPL/Execute/Browser.hsTest suite — metacommand parse & execution (60 → 102 tests)
Added
REPL.Meta,REPL.Preset, andREPL.Stateasother-modules(+Paths_impliautogen) in the test suite to enable REPL-level testing without touching the library API.Two new test groups in
test/Spec.hs:metaParseTests— 33 cases covering allCommandvariants (including single-letter abbreviations),Aspect,Option,Level, andElementparsing viaparser "test" input @?= Right expectedmetaExecTests— 10 cases runningreset/setactions through theREPL IOmonad and asserting the resultingStorefieldsSubdirectory READMEs
src/IMP/README.mdsrc/IMP/Semantics/README.mdsrc/REPL/README.mdREPL mmonad structure, dispatch flow, metacommand overviewsrc/REPL/Execute/README.mdhaskeline/InputT IO) vs. browser (WASM FFI/IO) backend comparisonweb/src/README.mdApp.tsx,impli.ts,util.ts,Unsupported.tsx) and WASM startup flowOriginal prompt
💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.