Skip to content

Commit 2b24a03

Browse files
committed
Minor fixups to README
1 parent 81220d0 commit 2b24a03

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

README.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ define the macro `STRONG_TYPE_IMPORT_STD_LIBRARY=1`.
7373
7474
# <A name="modifiers"/> Modifiers:
7575
76-
* <A name="affine_point"/>`strong::affine_point<D>` allows instances to be
76+
* <A name="affine_point"/>`strong::affine_point<D>` allows instances to be
7777
subtracted (yielding a `D`) or to add or subtract a `D` to an instance.
7878
See [Affine Space](https://en.wikipedia.org/wiki/Affine_space). Examples of
7979
one dimentional affine points are pointer (with `D` being `ptrdiff_t`,) or
@@ -197,7 +197,7 @@ define the macro `STRONG_TYPE_IMPORT_STD_LIBRARY=1`.
197197
198198
199199
* <A name="incrementable"/>`strong::incrementable`. Provides
200-
[`operator++](https://en.cppreference.com/w/cpp/language/operator_incdec) for
200+
[`operator++`](https://en.cppreference.com/w/cpp/language/operator_incdec) for
201201
the strong type, using the operator of the underlying type.
202202
203203
Available in `strong_type/incrementable.hpp`
@@ -245,14 +245,14 @@ define the macro `STRONG_TYPE_IMPORT_STD_LIBRARY=1`.
245245
Available in `strong_type/iterator.hpp`
246246
247247
248-
* <A name="ordered"/>`strong::ordered` provides operators '<', '<=', '>=' and
249-
'>'. The strong type offers the same ordering relatin as the underlying type.
248+
* <A name="ordered"/>`strong::ordered` provides operators `<`, `<=`, `>=` and
249+
`>`. The strong type offers the same ordering relation as the underlying type.
250250
251251
Available in `strong_type/ordered.hpp`
252252
253253
254-
* <A name="ordered_with"/>`strong::ordered_with<Ts...>` provides operators '<',
255-
'<=', '>=' and '>' between the strong type and each of the types `Ts...`.
254+
* <A name="ordered_with"/>`strong::ordered_with<Ts...>` provides operators `<`,
255+
`<=`, `>=` and `>` between the strong type and each of the types `Ts...`.
256256
Note! While `Ts` can include other strong types, it cannot refer to the strong
257257
type being defined. Use [`strong::ordered`](#ordered) for that.
258258
@@ -268,15 +268,15 @@ define the macro `STRONG_TYPE_IMPORT_STD_LIBRARY=1`.
268268
269269
270270
* <A name="partially_ordered"/>`strong::partially_ordered` provides operator
271-
'<=>' The strong type offers the same ordering relatin as the underlying type.
271+
`<=>` The strong type offers the same ordering relation as the underlying type.
272272
The result is [`std::partial_ordering`](https://en.cppreference.com/w/cpp/utility/compare/partial_ordering).
273273
Note! This does not imply [´strong::equality´](#equality).
274274
275275
Available in `strong_type/ordered.hpp`
276276
277277
278278
* <A name="partially_ordered_with"/>`strong::partially_ordered_with<Ts...>`
279-
provides operator '<=>' between the strong type and each of the types `Ts...`.
279+
provides operator `<=>` between the strong type and each of the types `Ts...`.
280280
Note! While `Ts` can include other strong types, it cannot refer to the strong
281281
type being defined. Use [`strong::partially_ordered`](#partially_ordered) for
282282
that. The result is [`std::partial_ordering`](https://en.cppreference.com/w/cpp/utility/compare/partial_ordering).
@@ -301,8 +301,8 @@ define the macro `STRONG_TYPE_IMPORT_STD_LIBRARY=1`.
301301
Available in `strong_type/range.hpp`
302302
303303
304-
* <A name="regular"/>`strong::regular`. Same as [`semiregular`](#semiregular)
305-
and also equality comparable. A good default base for most types.
304+
* <A name="regular"/>`strong::regular`. Same as [`strong::semiregular`](#semiregular)
305+
and [`strong::equality`](#equality). A good default base for most types.
306306
307307
Available in `strong_type/regular.hpp`
308308
@@ -315,14 +315,15 @@ define the macro `STRONG_TYPE_IMPORT_STD_LIBRARY=1`.
315315
Available in `strong_type/scalable_with.hpp`
316316
317317
318-
* <A name="semiregular"/>`strong::semiregular`. This gives you default
319-
constructible, move/copy constructible, move/copy assignable and swappable.
318+
* <A name="semiregular"/>`strong::semiregular`. This gives you
319+
[`strong::default_constructible`](#default_constructible)
320+
move/copy constructible, move/copy assignable and swappable.
320321
A decent default for many types.
321322
322323
Available in `strong_type/semiregular.hpp`.
323324
324325
325-
* <A name="strongly_ordered"/>`strong::strongly_ordered` provides operator '<=>'
326+
* <A name="strongly_ordered"/>`strong::strongly_ordered` provides operator `<=>`
326327
The strong type offers the same ordering relatin as the underlying type. The
327328
result is [`std::strong_ordering`](https://en.cppreference.com/w/cpp/utility/compare/strong_ordering).
328329
Note! This does not imply [´strong::equality<Ts...>´](#equality).
@@ -331,7 +332,7 @@ define the macro `STRONG_TYPE_IMPORT_STD_LIBRARY=1`.
331332
332333
333334
* <A name="strongly_ordered_with"/>`strong::strongly_ordered_with<Ts...>`
334-
provides operator '<=>' between the strong type and each of the types `Ts...`.
335+
provides operator `<=>` between the strong type and each of the types `Ts...`.
335336
Note! While `Ts` can include other strong types, it cannot refer to the strong
336337
type being defined. Use [`strong::strongly_ordered`](#strongly_ordered) for
337338
that. The result is [`std::strong_ordering`](https://en.cppreference.com/w/cpp/utility/compare/strong_ordering)
@@ -345,7 +346,7 @@ define the macro `STRONG_TYPE_IMPORT_STD_LIBRARY=1`.
345346
346347
Available in `strong_type/unique.hpp`
347348
348-
* <A name="weakly_ordered"/>`strong::weakly_ordered` provides operator '<=>'
349+
* <A name="weakly_ordered"/>`strong::weakly_ordered` provides operator `<=>`
349350
The strong type offers the same ordering relatin as the underlying type. The
350351
result is [`std::weak_ordering`](https://en.cppreference.com/w/cpp/utility/compare/weak_ordering).
351352
Note! This does not imply [´strong::equality´](#equality).
@@ -354,7 +355,7 @@ define the macro `STRONG_TYPE_IMPORT_STD_LIBRARY=1`.
354355
355356
356357
* <A name="weakly_ordered_with"/>`strong::weakly_ordered_with<Ts...>` provides
357-
operator '<=>' between the strong type and each of the types `Ts...`.
358+
operator `<=>` between the strong type and each of the types `Ts...`.
358359
Note! While `Ts` can include other strong types, it cannot refer to the strong
359360
type being defined. Use [`strong::weakly_ordered`](#weakly_ordered) for
360361
that. The result is [`std::weak_ordering`](https://en.cppreference.com/w/cpp/utility/compare/weak_ordering)
@@ -369,7 +370,8 @@ define the macro `STRONG_TYPE_IMPORT_STD_LIBRARY=1`.
369370
A number of small utilities are available directly in `strong_type/type.hpp`.
370371
371372
* `strong::type` provides a non-member `swap()` function as a friend, which
372-
swaps underlying values using.
373+
swaps underlying values using [`std::swap`](https://en.cppreference.com/w/cpp/algorithm/swap)
374+
or a specific swap function for the underlying type.
373375
374376
375377
* `strong::underlying_type<Type>` is `T` for `strong::type<T, Tag, Ms...>` and
@@ -714,4 +716,4 @@ correctly. Those found to cause trouble are disabled for those versions.
714716

715717
Discussions, pull-requests, flames are welcome.
716718

717-
[@bjorn_fahller](https://twitter.com/bjorn_fahller)
719+
[https://fosstodon.org/@rollbear](https://fosstodon.org/@rollbear), [@rollbear.bsky.social](https://bsky.app/profile/rollbear.bsky.social)

0 commit comments

Comments
 (0)