Skip to content

Commit 6592bba

Browse files
authored
clarified package names
1 parent ccfab9b commit 6592bba

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ python's `argparse` module:
77

88
## Contents
99

10-
### `WideHelpFormatter`
10+
### `formatter.WideHelpFormatter`
1111

1212
HelpFormatter which tries to use a given amount of the terminal width.
1313

@@ -16,18 +16,19 @@ This defaults to the full width (1.0). Override this class and set your own perc
1616

1717
This uses ``shutil.get_terminal_size()`` to determine the line length.
1818

19-
### `ThreeQuarterWidthHelpFormatter`
19+
### `formatter.ThreeQuarterWidthHelpFormatter`
2020

2121
A `WideHelpFormatter` subclass with its `percentage_of_line_length` set to three quarters of the terminal line length.
2222

23-
### `ThreeQuarterWidthDefaultsHelpFormatter`
23+
### `formatter.ThreeQuarterWidthDefaultsHelpFormatter`
2424

2525
A `ThreeQuarterWidthHelpFormatter` subclass which also derives from `argparse.ArgumentDefaultsHelpFormatter`. This means that in addition to using 3/4 of the terminal line length, it also prints the argument defaults in the help text.
2626

2727
## Usage
2828

2929
Use these classes in the same way as any other `argparse.HelpFormatter` subclass while creating your argument parser:
3030

31-
parser = argparse.ArgumentParser(formatter_class=<HelpFormatter>)
31+
from apextras.formatter import WideHelpFormatter
32+
parser = argparse.ArgumentParser(formatter_class=WideHelpFormatter)
3233
parser.add_argument(...)
3334
...

0 commit comments

Comments
 (0)