Skip to content

Commit

Permalink
Nicer docs for _r and _rs literals. (#441)
Browse files Browse the repository at this point in the history
  • Loading branch information
danakj authored Dec 20, 2023
1 parent b431afc commit e209b3f
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions sus/ops/range_literals.h
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

0 comments on commit e209b3f

Please sign in to comment.