Skip to content

Commit

Permalink
Fix markdown in README doc comments
Browse files Browse the repository at this point in the history
Blank line is needed after summary paragraph.
  • Loading branch information
dabrahams authored Oct 25, 2024
1 parent dc64b3c commit 6c6c0c2
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,7 @@ For example,
#include <climits>

/// A half-open range of integers.
///
/// - Invariant: start() <= end().
class int_range {
/// The lower bound; if `*this` is non-empty, its
Expand All @@ -185,6 +186,7 @@ class int_range {
bool is_valid() const { return start() <= end(); }
public:
/// An instance with the given bounds.
///
/// - Precondition: `end >= start`.
int_range(int start, int end) : _start(start), _end(end) {
ADOBE_PRECONDITION(end >= start, "invalid range bounds.");
Expand All @@ -200,6 +202,7 @@ public:
int end() const { return _end; }

/// Increases the upper bound by 1.
///
/// - Precondition: `end() < INT_MAX`.
void grow_rightward() {
ADOBE_PRECONDITION(end() < INT_MAX);
Expand Down

0 comments on commit 6c6c0c2

Please sign in to comment.