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

Nicer docs for _r and _rs literals. #441

Merged
merged 2 commits into from
Dec 20, 2023
Merged

Nicer docs for _r and _rs literals. #441

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
47b981d
Nicer docs for _r and _rs literals.
danakj Dec 19, 2023
59fe14b
Typo
danakj Dec 19, 2023
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
12 changes: 6 additions & 6 deletions sus/ops/range_literals.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,10 +170,10 @@ struct RangeLiteralDeducer {

} // namespace sus::ops

/// Constructs a literal range that satisfies the
/// [`RangeBounds<usize>`]($sus::ops::RangeBounds) concept.
/// Constructs a [`usize`]($sus::num::usize) range from a literal.
///
/// Because `usize` is unsigned, numbers may not be negative.
/// The constructed range satisfies the [`RangeBounds<usize>`]($sus::ops::RangeBounds)
/// concept. Because `usize` is unsigned, numbers may not be negative.
///
/// The syntax is:
/// * `start..end` for a range including start and excluding end. This returns a
Expand Down Expand Up @@ -201,10 +201,10 @@ constexpr auto operator""_r() {
return ::sus::ops::Range<::sus::num::usize>(D.lower, D.upper);
}

/// Constructs a literal range that satisfies the
/// [`RangeBounds<isize>`]($sus::ops::RangeBounds) concept.
/// Constructs an [`isize`]($sus::num::isize) range from a literal.
///
/// Numbers may be positive or negative.
/// The constructed range satisfies the [`RangeBounds<isize>`]($sus::ops::RangeBounds)
/// concept. Numbers may be positive or negative.
///
/// The syntax is:
/// * `start..end` for a range including start and excluding end. This returns a
Expand Down