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.

Sign up for GitHub

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

Fix markdown in README doc comments #31

Merged
merged 1 commit into from
Oct 25, 2024
Merged

Fix markdown in README doc comments #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
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