Skip to content

Commit a2dc03d

Browse files
Fix documentation accuracy and test parallelization issues (#31)
* Initial plan * Fix README.md report format example to match actual code output Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com> * Fix guide.md report format documentation to match actual output Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com> * Disable test parallelization to fix intermittent failures with console output capturing Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com> * Simplify Parallelize attribute per code review feedback Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com> * Use DoNotParallelize attribute per code review feedback Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
1 parent c41221b commit a2dc03d

File tree

3 files changed

+6
-9
lines changed

3 files changed

+6
-9
lines changed

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -163,14 +163,12 @@ Example report structure:
163163

164164
**Tool:** MockTool 1.0.0
165165

166-
**Results:** 2
167-
168166
## Results
169167

170168
Found 2 results
171169

172-
src/Program.cs(42): warning TEST001: Test issue 1
173-
src/Helper.cs(15): error TEST002: Test issue 2
170+
src/Program.cs(42): warning [TEST001] Test issue 1
171+
src/Helper.cs(15): error [TEST002] Test issue 2
174172
```
175173

176174
## Contributing

docs/guide/guide.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -215,11 +215,10 @@ The generated markdown reports include:
215215
- **Tool Information**: Name and version of the analysis tool
216216
- **Summary**: Count of results found
217217
- **Results Details**: Detailed information about each finding, including:
218-
- Rule ID and description
219-
- Severity level
220218
- File location and line number
221-
- Code snippet (if available)
222-
- Remediation guidance (if available)
219+
- Severity level
220+
- Rule ID
221+
- Issue message
223222

224223
## Exit Codes
225224

test/DemaConsulting.SarifMark.Tests/AssemblyInfo.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@
2121
using System.Runtime.CompilerServices;
2222

2323
[assembly: InternalsVisibleTo("DemaConsulting.SarifMark.Tests")]
24-
[assembly: Parallelize(Scope = ExecutionScope.ClassLevel)]
24+
[assembly: DoNotParallelize]

0 commit comments

Comments
 (0)