mirror of
https://github.com/clap-rs/clap
synced 2024-12-14 14:52:33 +00:00
b93870c10a
The textwrap crate uses a simpler linear-time algorithm for wrapping
the text. The current algorithm in wrap_help uses several O(n) calls
to String::insert and String::remove, which makes it potentially
quadratic in complexity.
Comparing the 05_ripgrep benchmark at commits textwrap~2 and textwrap
gives this result on my machine:
name before ns/iter after ns/iter diff ns/iter diff %
build_app_long 22,101 21,099 -1,002 -4.53%
build_app_short 22,138 21,205 -933 -4.21%
build_help_long 514,265 284,467 -229,798 -44.68%
build_help_short 85,720 85,693 -27 -0.03%
parse_clean 23,471 22,859 -612 -2.61%
parse_complex 29,535 28,919 -616 -2.09%
parse_lots 422,815 414,577 -8,238 -1.95%
As part of this commit, the wrapping_newline_chars test was updated.
The old algorithm had a subtle bug where it would break lines too
early. That is, it wrapped the text like
ARGS:
<mode> x, max, maximum 20 characters, contains
symbols.
l, long Copy-friendly,
14 characters, contains symbols.
m, med, medium Copy-friendly, 8
characters, contains symbols.";
when it should really have wrapped it like
ARGS:
<mode> x, max, maximum 20 characters, contains
symbols.
l, long Copy-friendly, 14
characters, contains symbols.
m, med, medium Copy-friendly, 8
characters, contains symbols.";
Notice how the word "14" was incorrectly moved to the next line. There
is clearly room for the word on the line with the "l, long" option
since there is room for "contains" just above it.
I'm not sure why this is, but the algorithm in textwrap handles this
case correctly.
|
||
|---|---|---|
| .. | ||
| app.yml | ||
| app_settings.rs | ||
| arg_aliases.rs | ||
| borrowed.rs | ||
| completions.rs | ||
| conflicts.rs | ||
| default_vals.rs | ||
| delimiters.rs | ||
| derive_order.rs | ||
| example1_tmpl_full.txt | ||
| example1_tmpl_simple.txt | ||
| flags.rs | ||
| groups.rs | ||
| help.rs | ||
| hidden_args.rs | ||
| macros.rs | ||
| multiple_occurrences.rs | ||
| multiple_values.rs | ||
| opts.rs | ||
| positionals.rs | ||
| posix_compatible.rs | ||
| possible_values.rs | ||
| require.rs | ||
| subcommands.rs | ||
| template_help.rs | ||
| tests.rs | ||
| unique_args.rs | ||
| utf8.rs | ||
| version.rs | ||
| yaml.rs | ||