Refresh README, CLAUDE.md, DESCRIPTION and TAGS for the 1.5.0 API - #46
Merged
Conversation
The documentation predated CommandOptions, cancellation, elevation and the argument-vector overloads, and the API reference listed the three CommandOptions overloads under the Obsolete heading, where they do not belong. README gains Introduction and Features sections, the three-part installation block, a cancellation example, and an API reference in table form covering every non-obsolete overload, CommandOptions, both output handlers and the Elevation enum. The generic Acknowledgements section is dropped as it carried no specific content. CLAUDE.md is rewritten against the current code. It records that dotnet test reports "Zero tests ran" against this MSTest.Sdk and MTP combination and that the test executable has to be run directly with VSTest-style filters, why the cancellation re-check in RunAsync must not be removed, why ktsu.Semantics.Strings is referenced explicitly, and which build warnings that dependency chain is expected to produce. DESCRIPTION and TAGS are expanded to cover the process-shaping and cancellation capabilities.
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 refresh following #38–#41, which landed
CommandOptions, environment variables, the working directory, the cancellation fix, and the obsoletion of the command-string overloads.Correction
The API reference listed the three
CommandOptionsoverloads underneath the Obsolete heading — an error introduced in #45. They are not obsolete. Fixed, and the reference is now generated from the actual signatures: 9 non-obsolete overloads, 11 obsolete ones (4Execute, 7ExecuteAsync), which I cross-checked against the source rather than transcribing.README
## Introductionand## Features, and the standard three-part installation block (Package Manager Console / .NET CLI / PackageReference, pinned at the current 1.5.0).AbsoluteDirectoryPathrationale paragraph up next to the property it explains.RunCommand,CommandOptions,OutputHandler,LineOutputHandlerandElevation, with real constructor signatures including the optionalencodingparameter.- ### OutputHandler Classlist-marker artifact.&branch=mainscoping from 3b03e8f rather than reverting to the unscoped template form.CLAUDE.md
Rewritten against the current code — it still described a four-method API split on the first space, and listed .NET 9 as the newest target. Beyond the structural refresh it records several things that cost time to rediscover:
dotnet testreportsZero tests ranwith this MSTest.Sdk/MTP combination even though tests build and discover fine. The test executable must be run directly, and it takes VSTest-style--filter, not--filter-methodor--treenode-filter.RunAsyncmust not be removed, and why its regression test loops 50 times.ktsu.Semantics.Stringsis referenced explicitly (the SDK'sKTSU0006analyzer rejects usingWeakStringtransitively) and which TFM-support warnings that dependency chain is expected to produce, so they are not mistaken for a regression.[CallerMemberName]-derived names for parallel-safety, and keeping theCS0618region tight.DESCRIPTION / TAGS
Both predated the new capabilities. DESCRIPTION now covers argument-vector passing, process shaping and cancellation; TAGS gains the corresponding terms plus the baseline
.NET/C#tags, and stays semicolon-separated.Note on CI
The
.NET Workflowhaspaths-ignore: ["**.md", ...], and this PR touches only.mdfiles — so no checks will run on it. That is the workflow behaving as configured, not a failure, but it does mean this one will not auto-merge on green the way #42–#45 did.Verified locally: builds clean across all eight target frameworks, 33 tests pass and 2 skip.
🤖 Generated with Claude Code
https://claude.ai/code/session_01LwKTWcmxe5mh6DsLRj5NGQ