docs: remove duplicate Testing section, list the semaphore sample#143
Conversation
The semaphore documentation added in #117 introduced a second "## Testing" section just before Samples, shadowing the fuller pre-existing one that covers the Docker-based integration tests. Remove the duplicate and add the new MultiLock.SemaphoreSample to the Samples section with its run command. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011D79i3saTKrBEKrhpMuDWv
PR Summary by Qododocs: remove duplicate Testing section and list semaphore sample in README
AI Description
High-Level Assessment
Files changed (1)
|
Code Review by Qodo
1. Semaphore sample args mismatch
|
| # Run the semaphore sample: dotnet run [provider] [maxConcurrent] | ||
| cd samples/MultiLock.SemaphoreSample | ||
| dotnet run inmemory 3 |
There was a problem hiding this comment.
1. Semaphore sample args mismatch 🐞 Bug ≡ Correctness
README documents running the semaphore sample as dotnet run [provider] [maxConcurrent], but the sample supports an optional third positional argument for provider connection strings and advertises that in its usage text. This can mislead users into thinking connection strings are not accepted or that extra args are invalid.
Agent Prompt
### Issue description
The README’s semaphore sample command line usage is incomplete: it mentions only two arguments (`[provider] [maxConcurrent]`), while the sample supports a third optional argument for provider connection strings.
### Issue Context
The sample’s `Program.cs` reads `args[2]` for multiple providers (e.g., sqlserver/redis/postgresql) and prints usage including `[connection_string]`.
### Fix Focus Areas
- README.md[809-811]
### Suggested change
Update the README line to reflect the optional third argument (e.g., `dotnet run [provider] [maxConcurrent] [connectionString]`) and optionally add one example showing a provider that uses it (e.g., `redis` or `sqlserver`).
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #143 +/- ##
==========================================
+ Coverage 72.61% 72.73% +0.12%
==========================================
Files 65 65
Lines 4974 4974
Branches 608 608
==========================================
+ Hits 3612 3618 +6
+ Misses 1156 1153 -3
+ Partials 206 203 -3 see 2 files with indirect coverage changes Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
Small README cleanup following the #117 merge. The distributed semaphore functionality itself is already fully documented (use cases, quick start, service usage patterns, per-provider registration, configuration options, semaphore-vs-leader-election comparison) — this fixes two blemishes that #117's README changes introduced:
## Testingsection: feat: add distributed counting semaphore with multi-provider support #117 added a short Testing section right before Samples, shadowing the fuller pre-existing one that documents the Docker-based integration tests. The duplicate is removed; the complete section remains.samples/MultiLock.SemaphoreSample/but didn't list it in the Samples section. It's now listed with its run command (dotnet run [provider] [maxConcurrent]).🤖 Generated with Claude Code
https://claude.ai/code/session_011D79i3saTKrBEKrhpMuDWv
Generated by Claude Code