question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

SA1629 code fix sometimes inserts periods just before last character

See original GitHub issue

SA1629 will flag docs such as these as needing to end with a period:

        /// <typeparam name="S">The service interface to retrieve</typeparam>
        /// <param name="provider">The IServiceProvider implementation</param>
        /// <returns>A reference to the service</returns>

The (bulk) code fix provider produced this:

        /// <typeparam name="S">The service interface to retriev.e</typeparam>
        /// <param name="provider">The IServiceProvider implementation.</param>
        /// <returns>A reference to the servic.e</returns>

Note this doesn’t always repro. When I undo just a few lines to their period-less state and reapply the code fix, the period goes to the right place. It only happens when there are a massive number (possibly hundreds) of fixes applied in bulk.

Issue Analytics

  • State:open
  • Created 4 years ago
  • Comments:7 (7 by maintainers)

github_iconTop GitHub Comments

1reaction
sharwellcommented, Jul 13, 2020

@AArnott In the last image (https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/2957#issuecomment-657241850), the code fix is correct. The <code> element designates a new paragraph. The equivalent inline element is <c>. DotNetAnalyzers/DocumentationAnalyzers contains analyzers which should detect this case.

0reactions
AArnottcommented, Jul 12, 2020

In fact it can be in the middle of a paragraph!

image

Read more comments on GitHub >

github_iconTop Results From Across the Web

SA1629 bug #2680 - DotNetAnalyzers/StyleCopAnalyzers
It also affects the code fix, as due to the wrong reporting location the period is inserted in the wrong spot.
Read more >
StyleCopAnalyzers/documentation/SA1629.md at master
Cause. A section of the Xml header documentation for a C# element does not end with a period (also known as a full...
Read more >
Irregular Periods (Abnormal Menstruation): Causes & ...
An irregular period is when your period comes early, late or not at all, or when the length of your menstrual cycle changes....
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found