Skip to content

Commit 6ccfac1

Browse files
committed
Slightly reformat overview of symbol_mode
1 parent b54a19f commit 6ccfac1

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -419,11 +419,12 @@ colors for the `formatter::format` method and it may not be able to detect if so
419419
not. For this reason, `formatter::format` and `formatter::print` methods have overloads taking a color parameter. This
420420
color parameter will override configured color mode.
421421
422-
The `symbols` option provides a few settings for pretty-printing symbol names. By default the full name is printed.
422+
The `symbols` option provides a few settings for pretty-printing symbol names:
423+
- `symbol_mode::full` default, uses the full demangled name
423424
- `symbol_mode::pretty` applies a number of transformations to clean up long symbol names. For example, it turns
424425
`std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >` into `std::string`. This is
425426
equivalent to `cpptrace::prettify_symbol`.
426-
- `symbol_mode::prune` prunes demangled symbols by removing return types, template arguments, and function parameters.
427+
- `symbol_mode::pruned` prunes demangled symbols by removing return types, template arguments, and function parameters.
427428
It also does some minimal normalization. For example, it prunes `ns::S<int, float>::~S()` to `ns::S::~S`. If cpptrace
428429
is unable to parse the symbol it will uses the full symbol. This is equivalent to `cpptrace::prune_symbol`.
429430

0 commit comments

Comments
 (0)