Skip to content

Commit fe8b799

Browse files
Copilotthomhurst
andauthored
Fix docs stating incorrect default for coverage output format (#3936)
* Initial plan * Fix docs stating incorrect default for coverage output format The documentation incorrectly stated that Cobertura is the default coverage output format. However, .NET 10 produces binary .coverage files by default if the --coverage-output-format flag is not supplied. Fixes documentation in migration guides (xunit, nunit, mstest), extensions, and troubleshooting files. Co-authored-by: thomhurst <30480171+thomhurst@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: thomhurst <30480171+thomhurst@users.noreply.github.com>
1 parent dc0752c commit fe8b799

File tree

5 files changed

+8
-8
lines changed

5 files changed

+8
-8
lines changed

docs/docs/extensions/extensions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ dotnet run --configuration Release --coverage
2222
# Specify output location
2323
dotnet run --configuration Release --coverage --coverage-output ./coverage/
2424

25-
# Specify output format (cobertura is default)
25+
# Specify output format (default is binary .coverage file)
2626
dotnet run --configuration Release --coverage --coverage-output-format cobertura
2727

2828
# Multiple formats

docs/docs/migration/mstest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1013,7 +1013,7 @@ dotnet run --configuration Release --coverage
10131013
# Specify output location
10141014
dotnet run --configuration Release --coverage --coverage-output ./coverage/
10151015

1016-
# Specify coverage format (default is cobertura)
1016+
# Specify coverage format (default is binary .coverage file)
10171017
dotnet run --configuration Release --coverage --coverage-output-format cobertura
10181018

10191019
# Multiple formats
@@ -1055,7 +1055,7 @@ If you have CI/CD pipelines that reference Coverlet, update them to use the new
10551055
The Microsoft coverage tool supports multiple output formats:
10561056
10571057
```bash
1058-
# Cobertura (default, widely supported)
1058+
# Cobertura (widely supported)
10591059
dotnet run --configuration Release --coverage --coverage-output-format cobertura
10601060

10611061
# XML (Visual Studio format)

docs/docs/migration/nunit.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -746,7 +746,7 @@ dotnet run --configuration Release --coverage
746746
# Specify output location
747747
dotnet run --configuration Release --coverage --coverage-output ./coverage/
748748

749-
# Specify coverage format (default is cobertura)
749+
# Specify coverage format (default is binary .coverage file)
750750
dotnet run --configuration Release --coverage --coverage-output-format cobertura
751751

752752
# Multiple formats
@@ -788,7 +788,7 @@ If you have CI/CD pipelines that reference Coverlet, update them to use the new
788788
The Microsoft coverage tool supports multiple output formats:
789789
790790
```bash
791-
# Cobertura (default, widely supported)
791+
# Cobertura (widely supported)
792792
dotnet run --configuration Release --coverage --coverage-output-format cobertura
793793

794794
# XML (Visual Studio format)

docs/docs/migration/xunit.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1054,7 +1054,7 @@ dotnet run --configuration Release --coverage
10541054
# Specify output location
10551055
dotnet run --configuration Release --coverage --coverage-output ./coverage/
10561056

1057-
# Specify coverage format (default is cobertura)
1057+
# Specify coverage format (default is binary .coverage file)
10581058
dotnet run --configuration Release --coverage --coverage-output-format cobertura
10591059

10601060
# Multiple formats
@@ -1096,7 +1096,7 @@ If you have CI/CD pipelines that reference Coverlet, update them to use the new
10961096
The Microsoft coverage tool supports multiple output formats:
10971097
10981098
```bash
1099-
# Cobertura (default, widely supported)
1099+
# Cobertura (widely supported)
11001100
dotnet run --configuration Release --coverage --coverage-output-format cobertura
11011101

11021102
# XML (Visual Studio format)

docs/docs/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2240,7 +2240,7 @@ dotnet run --configuration Release --coverage --coverage-settings coverage.runse
22402240

22412241
#### 1. Check Output Format
22422242
```bash
2243-
# Default is Cobertura (widely supported)
2243+
# Cobertura (widely supported)
22442244
dotnet run --configuration Release --coverage --coverage-output-format cobertura
22452245

22462246
# For Visual Studio

0 commit comments

Comments
 (0)