Skip to content

Commit eb3b2de

Browse files
committed
Fixed some documentation syntax
1 parent c1265b4 commit eb3b2de

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ The purpose of this project is to update specific aspects of code below a direct
44

55
It would be great to get this to work for all kinds of languages/frameworks someday, but for now it's just .NET and a little bit for NPM.
66

7-
## What Updates Cane Be Done
8-
9-
- Update .NET *.csproj files to use a specified C# Language Version
10-
- Update .NET *.csproj files to use a specified .NET SDK Version (AKA TargetFramework element)
11-
- Enable/Disable .NET Analyzers in all *.csproj files
12-
- Run `dotnet format` command on all *.csproj files
13-
- Update all NuGet packages in all *.csproj files to the latest version
14-
- Add Nuget auditing properties to all *.csproj files
7+
## What Updates Can Be Done
8+
9+
- Update .NET `*.csproj` files to use a specified C# Language Version
10+
- Update .NET `*.csproj` files to use a specified .NET SDK Version (AKA TargetFramework element)
11+
- Enable/Disable .NET Analyzers in all `*.csproj` files
12+
- Run `dotnet format` command on all `*.csproj` files
13+
- Update all NuGet packages in all *`.csproj` files to the latest version
14+
- Add Nuget auditing properties to all `*.csproj` files
1515
- Update all NPM packages in all package.json files to the latest version
1616

1717
## How to Use It
@@ -67,16 +67,16 @@ This is a config file used by the app to determine what updates to run. It is co
6767
- Child Objects:
6868
- CsProjVersioningOptions
6969
- Optional
70-
- Versioning options for csproj files
70+
- Versioning options for `*.csproj` files
7171
- Required Properties:
7272
- TargetFramework
73-
- String. Target Framework to set in all *.csproj files
73+
- String. Target Framework to set in all `*.csproj` files
7474
- LangVersion
75-
- String. C# language version to set in all *.csproj files
75+
- String. C# language version to set in all `*.csproj` files
7676
- TreatWarningsAsErrors
77-
- Boolean. The value to set for the TreatWarningsAsErrors flag in all *.csproj files
77+
- Boolean. The value to set for the TreatWarningsAsErrors flag in all `*.csproj` files
7878
- CsProjDotNetAnalyzerOptions
79-
- .NET Analyzer settings to set in all csproj files
79+
- .NET Analyzer settings to set in all `*.csproj` files
8080
- Required Properties:
8181
- EnableNetAnalyzers
8282
- Boolean. True to set the `EnableNetAnalyzers` csproj value to true, false to set it to false
@@ -191,7 +191,7 @@ PowerShell is required as a workaround. The NPM executable on Windows doesn't ru
191191

192192
## .NET Standard Projects
193193

194-
When updating *.csproj files to a specific `TargetFramework` version, the project is skipped if using .NET Standard. Those are usually set for a specific level of API compatibility so we don't want to mess with those.
194+
When updating csproj files to a specific `TargetFramework` version, the project is skipped if using .NET Standard. Those are usually set for a specific level of API compatibility so we don't want to mess with those.
195195

196196
## Update Script Sample
197197

code-update-runner-sample/code-updater-config.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
"EnforceCodeStyleInBuild": true
2222
},
2323
"CSharpStyleOptions": {
24-
"RunDotnetFormat": true
24+
"RunDotnetFormat": false
2525
},
2626
"NugetAuditOptions": {
2727
"NuGetAudit": true,
@@ -30,7 +30,7 @@
3030
},
3131
"NuGetUpdateOptions": {
3232
"UpdateTopLevelNugetsInCsProj": true,
33-
"UpdateTopLevelNugetsNotInCsProj": true
33+
"UpdateTopLevelNugetsNotInCsProj": false
3434
}
3535
},
3636
"NpmOptions": {

0 commit comments

Comments
 (0)