Skip to content

Commit f38bd65

Browse files
authored
Add links to the changelog (#96)
1 parent 2527012 commit f38bd65

File tree

1 file changed

+58
-39
lines changed

1 file changed

+58
-39
lines changed

CHANGELOG.md

Lines changed: 58 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -4,60 +4,67 @@
44

55
### Features
66
- Make `RichHelpFormatter` itself a rich renderable.
7-
* PR #90
7+
* PR [#90](https://github.com/hamdanal/rich-argparse/pull/90)
88
- Allow passing custom console to `RichHelpFormatter`.
9-
* Issue #91, PR #92
9+
* Issue [#91](https://github.com/hamdanal/rich-argparse/issues/91),
10+
PR [#92](https://github.com/hamdanal/rich-argparse/pull/92)
1011
- Add `HelpPreviewAction` to generate a preview of the help output in SVG, HTML, or TXT formats.
11-
* Issue #91, PR #93
12+
* Issue [#91](https://github.com/hamdanal/rich-argparse/issues/91),
13+
PR [#93](https://github.com/hamdanal/rich-argparse/pull/93)
1214

1315
## 1.3.0 - 2023-08-19
1416

1517
### Features
1618
- Add `optparse.GENERATE_USAGE` to auto generate a usage similar to argparse.
17-
* PR #87
19+
* PR [#87](https://github.com/hamdanal/rich-argparse/pull/87)
1820
- Add `rich_format_*` methods to optparse formatters. These return a `rich.text.Text` object.
19-
* PR #87
21+
* PR [#87](https://github.com/hamdanal/rich-argparse/pull/87)
2022

2123
### Fixes
2224
- Fix ansi escape codes on legacy Windows console
23-
* Issue #79, PR #80, PR #85
25+
* Issue [#79](https://github.com/hamdanal/rich-argparse/issues/79),
26+
PR [#80](https://github.com/hamdanal/rich-argparse/pull/80),
27+
PR [#85](https://github.com/hamdanal/rich-argparse/pull/85)
2428

2529
## 1.2.0 - 2023-07-02
2630

2731
### Features
2832
- Add experimental support for `optparse`. Import optparse formatters from `rich_argparse.optparse`.
29-
* PR #73
33+
* PR [#73](https://github.com/hamdanal/rich-argparse/pull/73)
3034

3135
### Changes
3236
- The project now uses `ruff` for linting and import sorting.
33-
* PR #72
37+
* PR [#72](https://github.com/hamdanal/rich-argparse/pull/72)
3438
- `rich_argparse` is now a package instead of a module. This should not affect users.
35-
* PR #71
39+
* PR [#71](https://github.com/hamdanal/rich-argparse/pull/71)
3640

3741
### Fixes
3842
- Fix crash when a metavar following a long option contains control codes.
39-
* PR #74
43+
* PR [#74](https://github.com/hamdanal/rich-argparse/pull/74)
4044

4145
## 1.1.1 - 2023-05-30
4246

4347
### Fixes
4448
- Fix `%` not being escaped properly.
45-
* Issue #67, PR #69
49+
* Issue [#67](https://github.com/hamdanal/rich-argparse/issues/67),
50+
PR [#69](https://github.com/hamdanal/rich-argparse/pull/69)
4651
- Restore lazy loading of `rich`. Delay its import until it is needed.
47-
* PR #68
52+
* PR [#68](https://github.com/hamdanal/rich-argparse/pull/68)
4853

4954
## 1.1.0 - 2023-03-11
5055

5156
### Features
5257
- Add a new style for `%(prog)s` in the usage. The style is applied in argparse-generated usage and
5358
in user defined usage whether the user usage is plain text or rich markup.
54-
* Issue #55, PR #56
59+
* Issue [#55](https://github.com/hamdanal/rich-argparse/issues/55),
60+
PR [#56](https://github.com/hamdanal/rich-argparse/pull/56)
5561

5662
## 1.0.0 - 2023-01-07
5763

5864
### Fixes
5965
- `RichHelpFormatter` now respects format conversion types in help strings
60-
* Issue #49, PR #50
66+
* Issue [#49](https://github.com/hamdanal/rich-argparse/issues/49),
67+
PR [#50](https://github.com/hamdanal/rich-argparse/pull/50)
6168

6269
## 0.7.0 - 2022-12-31
6370

@@ -66,31 +73,33 @@
6673
better with long group names and follows the convention of popular CLI tools and programs.
6774
Please note that if you test the output of your CLI **verbatim** and rely on the default behavior
6875
of rich_argparse, you will have to either set the formatter explicitly or update the tests.
69-
* Issue #47, PR #48
76+
* Issue [#47](https://github.com/hamdanal/rich-argparse/issues/47),
77+
PR [#48](https://github.com/hamdanal/rich-argparse/pull/48)
7078

7179
## 0.6.0 - 2022-12-18
7280

7381
### Features
7482
- Support type checking for users. Bundle type information in the wheel and sdist.
75-
* PR #43
83+
* PR [#43](https://github.com/hamdanal/rich-argparse/pull/43)
7684

7785
### Fixes
7886
- Fix annotations of class variables previously typed as instance variables.
79-
* PR #43
87+
* PR [#43](https://github.com/hamdanal/rich-argparse/pull/43)
8088

8189
## 0.5.0 - 2022-11-05
8290

8391
### Features
8492
- Support console markup in **custom** `usage` messages. Note that this feature is not activated by
8593
default. To enable it, set `RichHelpFormatter.usage_markup = True`.
86-
* PR #38
94+
* PR [#38](https://github.com/hamdanal/rich-argparse/pull/38)
8795

8896
### Fixes
8997
- Use `soft_wrap` in `console.print` instead of a large fixed console width for wrapping
90-
* PR #35
98+
* PR [#35](https://github.com/hamdanal/rich-argparse/pull/35)
9199
- Fix a regression in highlight regexes that caused the formatter to crash when using the same
92100
style multiple times.
93-
* Issue #36, PR #37
101+
* Issue [#36](https://github.com/hamdanal/rich-argparse/issues/36),
102+
PR [#37](https://github.com/hamdanal/rich-argparse/pull/37)
94103

95104
## 0.4.0 - 2022-10-15
96105

@@ -107,74 +116,84 @@
107116
Note that this changes the default behavior of `RichHelpFormatter` to no longer respect line
108117
breaks in the description and help text. It now behaves similarly to the original
109118
`HelpFormatter`. You have now to use the appropriate subclass for this to happen.
110-
* PR #31
119+
* PR [#31](https://github.com/hamdanal/rich-argparse/pull/31)
111120

112121
## 0.3.1 - 2022-10-08
113122

114123
### Fixes
115124
- Fix required options not coloured in the usage
116-
* Issue #28, PR #30
125+
* Issue [#28](https://github.com/hamdanal/rich-argparse/issues/28),
126+
PR [#30](https://github.com/hamdanal/rich-argparse/pull/30)
117127

118128
## 0.3.0 - 2022-10-01
119129

120130
### Features
121131
- A new custom usage lexer that is consistent with the formatter styles
122-
* Issue #16, PR #17
132+
* Issue [#16](https://github.com/hamdanal/rich-argparse/issues/16),
133+
PR [#17](https://github.com/hamdanal/rich-argparse/pull/17)
123134

124135
### Fixes
125136
- Fix inconsistent coloring of args in the top usage panel
126-
* Issue #16, PR #17
137+
* Issue [#16](https://github.com/hamdanal/rich-argparse/issues/16),
138+
PR [#17](https://github.com/hamdanal/rich-argparse/pull/17)
127139
- Fix incorrect line breaks that put metavars on a alone on a new line
128-
* Issue #12, PR #20
140+
* Issue [#12](https://github.com/hamdanal/rich-argparse/issues/12),
141+
PR [#20](https://github.com/hamdanal/rich-argparse/pull/20)
129142
- Do not print help output, return it instead
130-
* Issue #19, PR #21
143+
* Issue [#19](https://github.com/hamdanal/rich-argparse/issues/19),
144+
PR [#21](https://github.com/hamdanal/rich-argparse/pull/21)
131145

132146
### Changes
133147
- The default styles have been changed to be more in line with the new usage coloring
134-
* PR #17
148+
* PR [#17](https://github.com/hamdanal/rich-argparse/pull/17)
135149
- The default `max_help_position` is now set to 24 (the default used in argparse) as line breaks
136150
are no longer an issue
137-
* PR #20
151+
* PR [#20](https://github.com/hamdanal/rich-argparse/pull/20)
138152

139153
### Removed
140154
- The `RichHelpFormatter.renderables` property has been removed, it was never documented
141-
* PR #20
155+
* PR [#20](https://github.com/hamdanal/rich-argparse/pull/20)
142156

143157
### Tests
144158
- Run windows tests in CI
145-
* PR #22
159+
* PR [#22](https://github.com/hamdanal/rich-argparse/pull/22)
146160

147161
## 0.2.1 - 2022-09-25
148162

149163
### Fixes
150164
- Fix compatibility with `argparse.ArgumentDefaultsHelpFormatter`
151-
* Issue #13, PR #14
165+
* Issue [#13](https://github.com/hamdanal/rich-argparse/issues/13),
166+
PR [#14](https://github.com/hamdanal/rich-argparse/pull/14)
152167

153168
## 0.2.0 - 2022-09-17
154169

155170
### Features
156171
- Metavars now have their own style `argparse.metavar` which defaults to `'bold cyan'`
157-
* Issue #4, PR #9
172+
* Issue [#4](https://github.com/hamdanal/rich-argparse/issues/4),
173+
PR [#9](https://github.com/hamdanal/rich-argparse/pull/9)
158174

159175
### Fixes
160176
- Add missing ":" after the group name similar to the default HelpFormatter
161-
* Issue #4, PR #10
177+
* Issue [#4](https://github.com/hamdanal/rich-argparse/issues/4),
178+
PR [#10](https://github.com/hamdanal/rich-argparse/pull/10)
162179
- Fix padding of long options or metavars
163-
* PR #11
180+
* PR [#11](https://github.com/hamdanal/rich-argparse/pull/11)
164181
- Fix overflow of text in help that was truncated
165-
* PR #11
182+
* PR [#11](https://github.com/hamdanal/rich-argparse/pull/11)
166183
- Escape parameters that get substituted with % such as %(prog)s and %(default)s
167-
* PR #11
184+
* PR [#11](https://github.com/hamdanal/rich-argparse/pull/11)
168185
- Fix flaky wrapping of long lines
169-
* PR #11
186+
* PR [#11](https://github.com/hamdanal/rich-argparse/pull/11)
170187

171188
## 0.1.1 - 2022-09-10
172189

173190
### Fixes
174191
- Fix `RichHelpFormatter` does not replace `%(prog)s` in text
175-
* Issue #5, PR #6
192+
* Issue [#5](https://github.com/hamdanal/rich-argparse/issues/5),
193+
PR [#6](https://github.com/hamdanal/rich-argparse/pull/6)
176194
- Fix extra newline at the end
177-
* Issue #7, PR #8
195+
* Issue [#7](https://github.com/hamdanal/rich-argparse/issues/7),
196+
PR [#8](https://github.com/hamdanal/rich-argparse/pull/8)
178197

179198
## 0.1.0 - 2022-09-03
180199

0 commit comments

Comments
 (0)