devdocs icon indicating copy to clipboard operation
devdocs copied to clipboard

C++: Spurious full stop

Open yurikhan opened this issue 4 years ago • 0 comments

Documentation style bug

Summary

In the original C++Reference pages, a sentence may span a paragraph, followed by a bulleted list or a preformatted code block, optionally followed by another paragraph. Example:

Formally, given

  • the pointer p represents the address A of a byte in memory
  • an object X is located at the address A

Actual style

On DevDocs, the first (incomplete) paragraph is displayed with a full stop at the end. This makes text a little bit more difficult to read.

image

Expected style

No spurious punctuation should be added.

yurikhan avatar Sep 14 '21 11:09 yurikhan