Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump version to 2.0.1-beta #187

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/dotnet.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ jobs:
dotnet add StyleChecker/StyleChecker.Test/StyleChecker.Test.csproj package StyleChecker --version ${{ env.STYLECHECKER_VERSION }}
dotnet build --configuration Release
env:
STYLECHECKER_VERSION: 2.0.0
STYLECHECKER_VERSION: 2.0.1-alpha
2 changes: 1 addition & 1 deletion 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-alpha</Version>
<Version>2.0.1-beta</Version>
<RepositoryType />
<Company>Maroontress Fast Software</Company>
<PackageReadmeFile>README.md</PackageReadmeFile>
Expand Down
46 changes: 46 additions & 0 deletions doc/rules/NoSingleSpaceAfterTripleSlash.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- markdownlint-disable MD024 MD033 MD041-->
<div class="project-logo">StyleChecker</div>
<div id="toc-level" data-values="H2,H3"></div>

Expand Down Expand Up @@ -42,6 +43,51 @@ This analyzer does not report diagnostics to the code, which includes
a line break inside the start/end tags of an XML element,
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:

```csharp
/// <summary>Hello.</summary>
/// <seealso cref="Good"/>
public static void Good()
{
}

/// <summary>Hello
/// World.</summary>
public static void GoodWithWrapping()
{
}
```

The following is a nonconformance example:

```csharp
/// Hello <summary>World.</summary>
/// See <seealso cref="Bad"/>
public static void Bad()
{
}

/// Hello.
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.

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

## Code fix

The code fix provides an option inserting a single space after `///`,
Expand Down