Skip to content

Commit 9133b90

Browse files
committed
Fix a couple of typos in the README
1 parent c8699bc commit 9133b90

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Cpptrace also has a C API, docs [here](docs/c-api.md).
5858
- [Package Managers](#package-managers)
5959
- [Conan](#conan)
6060
- [Vcpkg](#vcpkg)
61-
- [C++20 Moduels](#c20-moduels)
61+
- [C++20 Modules](#c20-modules)
6262
- [Platform Logistics](#platform-logistics)
6363
- [Windows](#windows)
6464
- [macOS](#macos)
@@ -437,7 +437,7 @@ The `symbols` option provides a few settings for pretty-printing symbol names:
437437
equivalent to `cpptrace::prettify_symbol`.
438438
- `symbol_mode::pruned` prunes demangled symbols by removing return types, template arguments, and function parameters.
439439
It also does some minimal normalization. For example, it prunes `ns::S<int, float>::~S()` to `ns::S::~S`. If cpptrace
440-
is unable to parse the symbol it will uses the full symbol. This is equivalent to `cpptrace::prune_symbol`.
440+
is unable to parse the symbol it will use the full symbol. This is equivalent to `cpptrace::prune_symbol`.
441441
442442
Recommended practice with formatters: It's generally preferable to create formatters objects that are long-lived rather
443443
than to create them on the fly every time a trace needs to be formatted.
@@ -597,9 +597,9 @@ CPPTRACE_TRY {
597597

598598
> [!IMPORTANT]
599599
> There is an unfortunate limitation with `return` statements in these try/catch macros: The implementation on Windows
600-
> requires wrapping the try body in an immediately-invoked lambda and and as such `return` statements would return from
601-
> the lambda not the enclosing function. Cpptrace guards against misleading `return`s compiling by requiring the lambdas
602-
> to return a special internal type, but, if you're writing code that will be compiled on windows it's important to not
600+
> requires wrapping the try body in an immediately-invoked lambda and as such `return` statements would return from the
601+
> lambda not the enclosing function. Cpptrace guards against misleading `return`s compiling by requiring the lambdas to
602+
> return a special internal type, but, if you're writing code that will be compiled on windows it's important to not
603603
> write `return` statements within CPPTRACE_TRY. For example, this is invalid:
604604
> ```cpp
605605
> CPPTRACE_TRY {
@@ -1510,7 +1510,7 @@ find_package(cpptrace CONFIG REQUIRED)
15101510
target_link_libraries(main PRIVATE cpptrace::cpptrace)
15111511
```
15121512

1513-
## C++20 Moduels
1513+
## C++20 Modules
15141514

15151515
Cpptrace supports C++20 modules: `import cpptrace;`. You'll need a modern toolchain in order to use C++20 modules (i.e.
15161516
relatively new compilers, cmake, etc).
@@ -1724,7 +1724,7 @@ Cpptrace provides functionality beyond what the standard library provides and wh
17241724
## What does cpptrace have over other C++ stacktrace libraries?
17251725

17261726
Other C++ stacktrace libraries, such as boost stacktrace and backward-cpp, fall short when it comes to portability and
1727-
ease of use. In testing, I found neither to provide adaquate coverage of various environments. Even when they can be
1727+
ease of use. In testing, I found neither to provide adequate coverage of various environments. Even when they can be
17281728
made to work in an environment they require manual configuration from the end-user, possibly requiring manual
17291729
installation of third-party dependencies. This is a highly undesirable burden to impose on users, especially when it is
17301730
for a software package which just provides diagnostics as opposed to core functionality. Additionally, cpptrace provides

0 commit comments

Comments
 (0)