Skip to content

Commit

Permalink
Bump version to 2.0.1 (#188)
Browse files Browse the repository at this point in the history
  • Loading branch information
maroontress-tomohisa authored Aug 13, 2024
1 parent cf14e2c commit 5519b78
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 16 deletions.
8 changes: 4 additions & 4 deletions StyleChecker/StyleChecker.Test/StyleChecker.Test.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -461,10 +461,10 @@
<ItemGroup>
<PackageReference Include="coverlet.collector" Version="6.0.2" PrivateAssets="all" />
<PackageReference Include="Maroontress.Oxbind" Version="1.0.3" />
<PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="4.9.2" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
<PackageReference Include="MSTest.TestAdapter" Version="3.3.1" />
<PackageReference Include="MSTest.TestFramework" Version="3.3.1" />
<PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="4.10.0" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
<PackageReference Include="MSTest.TestAdapter" Version="3.5.1" />
<PackageReference Include="MSTest.TestFramework" Version="3.5.1" />
<PackageReference Include="StyleChecker.Annotations" Version="1.0.1" />
<PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.556" PrivateAssets="all" />
</ItemGroup>
Expand Down
4 changes: 2 additions & 2 deletions StyleChecker/StyleChecker/StyleChecker.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<Copyright>Copyright (c) 2018 Maroontress Fast Software</Copyright>
<PackageTags>csharp, visual-studio, roslyn, analyzer, roslyn-analyzer, roslyn-codefix, stylechecker</PackageTags>
<NoPackageAnalysis>true</NoPackageAnalysis>
<Version>2.0.1-beta</Version>
<Version>2.0.1</Version>
<RepositoryType />
<Company>Maroontress Fast Software</Company>
<PackageReadmeFile>README.md</PackageReadmeFile>
Expand All @@ -44,7 +44,7 @@
</ItemGroup>

<ItemGroup>
<PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="4.9.2" PrivateAssets="all" />
<PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="4.10.0" PrivateAssets="all" />
<PackageReference Include="StyleChecker.Annotations" Version="$(AnnotationsVersion)" PrivateAssets="all" />
<PackageReference Include="Maroontress.Oxbind" Version="$(OxbindVersion)" PrivateAssets="all" />
<PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.556" PrivateAssets="all" />
Expand Down
22 changes: 12 additions & 10 deletions doc/rules/NoSingleSpaceAfterTripleSlash.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,12 @@ as long as a single space follows `///`.

## Remarks

A `///` followed by a single space is simply not correct. More correctly, `///`
must be followed by a single space followed by an XML element
(`<element>…</element>` or `<element … />`). If the XML element is long, it can
be wrapped, but each wrapped line must begin with `///` followed by one or more
whitespace characters. The following is a conformance example:
It is not sufficient to write a `///` followed by a single whitespace character.
More precisely, `///` must be followed by a single whitespace character followed
by an XML Element (`<element>…</element>` or `<element … />`). If the XML
element is long, it can be wrapped, but each wrapped line must begin with `///`
followed by one or more whitespace characters. The following is a conformance
example:

```csharp
/// <summary>Hello.</summary>
Expand Down Expand Up @@ -80,12 +81,12 @@ public static void BadWithNoElements()
}
```

The analyzer also issued diagnostics for `Hello` and `See` in `Bad()` up to
version 2.0.0, but not since 2.0.1. The warning was &ldquo;A single white space
is needed after '///',&rdquo; but &ldquo;A single white space should only be
between '///' and an XML element&rdquo; was more appropriate.
Before version 2.0.1, this analyzer issued diagnostics for `Hello` and `See` in
`Bad()`. The warning was &ldquo;A single white space is needed after
'///',&rdquo; but a more appropriate warning should have been &ldquo;Only one
whitespace character should be placed between /// and the XML element.&rdquo;

Even after version 2.0.1, [StrayText analyzer](StrayText.md) reports `Bad()` and
Even after version 2.0.1, [StrayText][] analyzer reports `Bad()` and
`BadWithNoElements()` instead of this analyzer.

## Code fix
Expand Down Expand Up @@ -133,3 +134,4 @@ public void Method(int a, int b)
https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1004.md
[fig-NoSingleSpaceAfterTripleSlash]:
https://maroontress.github.io/StyleChecker/images/NoSingleSpaceAfterTripleSlash.png
[StrayText]: StrayText.md

0 comments on commit 5519b78

Please sign in to comment.