Skip to content

Commit 0aec787

Browse files
committed
docs(CHANGES): Use normal issue linking format
%s/{issue}`\(\d\+\)`/#\1/ge
1 parent 00d3b39 commit 0aec787

File tree

1 file changed

+77
-77
lines changed

1 file changed

+77
-77
lines changed

CHANGES

+77-77
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ $ pip install --user --upgrade --pre libtmux
1616

1717
### Fixes
1818

19-
- {meth}`Server.new_session` _really_ works without `session_name`, {issue}`401` fixes
20-
{issue}`399`. Improved tests and doctests added.
19+
- {meth}`Server.new_session` _really_ works without `session_name`, #401 fixes
20+
#399. Improved tests and doctests added.
2121

2222
## libtmux 0.14.1 (2022-08-17)
2323

2424
### Fixes
2525

26-
- {meth}`Server.new_session` works without `session_name`, {issue}`400` fixes
27-
{issue}`399`
26+
- {meth}`Server.new_session` works without `session_name`, #400 fixes
27+
#399
2828

2929
_This still passed `None` to the session name, this was fixed in v0.14.2._
3030

@@ -33,33 +33,33 @@ $ pip install --user --upgrade --pre libtmux
3333
### Breaking changes
3434

3535
- {meth}`Pane.send_keys`: `suppress_history` default value changed from `True` to
36-
`False`, {issue}`395`
36+
`False`, #395
3737

3838
### Tests and docs
3939

40-
- Initial [doctests] examples stubbed out {issue}`394`
40+
- Initial [doctests] examples stubbed out #394
4141

4242
[doctests]: https://docs.python.org/3/library/doctest.html
4343

44-
- Fix bug in `temp_window()` context manager, {issue}`394`
44+
- Fix bug in `temp_window()` context manager, #394
4545
- Pytest configuration `conftest.py` moved to `libtmux/conftest.py`, so doctest can
46-
detect the fixtures {issue}`394`
46+
detect the fixtures #394
4747

4848
## libtmux 0.13.0 (2022-08-05)
4949

5050
### What's new
5151

5252
- **Improved typings**
5353

54-
Now [`mypy --strict`] compliant ({issue}`383`)
54+
Now [`mypy --strict`] compliant (#383)
5555

56-
Smaller touchups from {issue}`392`
56+
Smaller touchups from #392
5757

5858
[`mypy --strict`]: https://mypy.readthedocs.io/en/stable/command_line.html#cmdoption-mypy-strict
5959

6060
### Breaking changes
6161

62-
- Deprecated individual item lookups ({issue}`390`)
62+
- Deprecated individual item lookups (#390)
6363

6464
- Removed key lookups from {meth}`libtmux.common.EnvironmentMixin.show_environment`
6565

@@ -106,17 +106,17 @@ $ pip install --user --upgrade --pre libtmux
106106
window.show_window_option('DISPLAY')
107107
```
108108

109-
- Remove `libtmux.test.retry()`, deprecated since 0.12.x ({issue}`393`)
109+
- Remove `libtmux.test.retry()`, deprecated since 0.12.x (#393)
110110

111111
### Development
112112

113-
- Fix incorrect function name `findWhere()` ({issue}`391`)
113+
- Fix incorrect function name `findWhere()` (#391)
114114

115115
## libtmux 0.12.0 (2022-07-13)
116116

117117
### Compatibility
118118

119-
- Brought back python 3.7 and 3.8 support ({issue}`375`)
119+
- Brought back python 3.7 and 3.8 support (#375)
120120
- Support for tmux 3.3a
121121

122122
- Add to CI
@@ -131,21 +131,21 @@ $ pip install --user --upgrade --pre libtmux
131131

132132
This created issues with running poetry while inside the virtualenv.
133133

134-
- Typings: Core relations, e.g. `Pane.window`, `Pane.session`, `Pane.server`, `Window.server` {issue}`385`
134+
- Typings: Core relations, e.g. `Pane.window`, `Pane.session`, `Pane.server`, `Window.server` #385
135135

136136
### Documentation
137137

138138
- Renewed logo
139-
- Try out sphinx-autoapi for its table of contents generation ({issue}`367`)
139+
- Try out sphinx-autoapi for its table of contents generation (#367)
140140
- Break up API documentations for utilities, exception, and test helpers and
141141
remove duplicate docs from API page. Server, session, window, and pane docs
142142
are in the Reference section now.
143143

144144
### Testing
145145

146-
- `retry()`: Add deprecation warning. This will be removed in 0.13.x ({issue}`368`, {issue}`372`)
147-
- New function `retry_until()`: Polls a callback function for a set period of time until it returns `True` or times out. By default it will raise {exc}`libtmux.exc.WaitTimeout`, with `raises=False` it will return `False`. Thank you @categulario! ({issue}`368`, {issue}`372`)
148-
- {issue}`384` Chore: Use absolute modules rather than root-level to avoid cyclic imports.
146+
- `retry()`: Add deprecation warning. This will be removed in 0.13.x (#368, #372)
147+
- New function `retry_until()`: Polls a callback function for a set period of time until it returns `True` or times out. By default it will raise {exc}`libtmux.exc.WaitTimeout`, with `raises=False` it will return `False`. Thank you @categulario! (#368, #372)
148+
- #384 Chore: Use absolute modules rather than root-level to avoid cyclic imports.
149149

150150
```python
151151
# Bad / Old
@@ -157,7 +157,7 @@ $ pip install --user --upgrade --pre libtmux
157157

158158
### Internals
159159

160-
- {issue}`382` [mypy] support added:
160+
- #382 [mypy] support added:
161161

162162
- Basic mypy tests now pass
163163

@@ -172,21 +172,21 @@ $ pip install --user --upgrade --pre libtmux
172172
~~Bug fixes and security updates will go to
173173
[`v0.11.x`](https://github.com/tmux-python/libtmux/tree/v0.11.x)~~
174174

175-
- Internal: Use new separator to split `tmux(1)` formatting information ({issue}`289`,
176-
{issue}`343`)
175+
- Internal: Use new separator to split `tmux(1)` formatting information (#289,
176+
#343)
177177

178178
The separator is configurable via `LIBTMUX_TMUX_FORMAT_SEPARATOR`. If you ever
179179
have compatiblity issues in the future let us know which default works best
180180
across versions.
181181

182182
Credit: @JonathanRaiman and @jagguli
183183

184-
- Basic type annotations ({issue}`359`, {issue}`361`) via @otherJL0
184+
- Basic type annotations (#359, #361) via @otherJL0
185185

186186
### Development
187187

188-
- Code cleanup ({issue}`362`) from @otherJL0
189-
- Format with black w/ string normalization. This is a one-time diff ({issue}`354`)
188+
- Code cleanup (#362) from @otherJL0
189+
- Format with black w/ string normalization. This is a one-time diff (#354)
190190

191191
### Documentation
192192

@@ -197,88 +197,88 @@ $ pip install --user --upgrade --pre libtmux
197197

198198
### Packaging
199199

200-
First experimental release using `poetry build` ({issue}`347`). If you are packaging and run
201-
across any difficulty please see {issue}`346`.
200+
First experimental release using `poetry build` (#347). If you are packaging and run
201+
across any difficulty please see #346.
202202

203203
### Compatibility
204204

205-
- Drop python 3.6 ({issue}`344`)
206-
- Add python 3.10, though still `packaging.version` issues remain ({issue}`344`)
205+
- Drop python 3.6 (#344)
206+
- Add python 3.10, though still `packaging.version` issues remain (#344)
207207

208208
A compat module and version constraints will need to be added for this
209209

210210
### Development
211211

212-
- poetry: 1.1.7 -> 1.1.12 ({issue}`344`)
213-
- Add `.pre-commit-config.yaml` ({issue}`344`)
212+
- poetry: 1.1.7 -> 1.1.12 (#344)
213+
- Add `.pre-commit-config.yaml` (#344)
214214

215215
## libtmux 0.10.2 (2021-10-30)
216216

217-
- {issue}`324`: Update poetry to 1.1
217+
- #324: Update poetry to 1.1
218218
- CI: Use poetry 1.1.7 and `install-poetry.py` installer
219219
- Relock poetry.lock at 1.1 (w/ 1.1.7's fix)
220-
- {issue}`339` (CI): Lock python at 3.9 to avoid poetry issue with `dataclasses`
221-
- ci: Fix publishing docs (similar to {issue}`339`)
222-
- {issue}`341` {issue}`342`: `Server.attached_sessions()` now supports multiple attached sessions.
220+
- #339 (CI): Lock python at 3.9 to avoid poetry issue with `dataclasses`
221+
- ci: Fix publishing docs (similar to #339)
222+
- #341 #342: `Server.attached_sessions()` now supports multiple attached sessions.
223223

224224
Remove attached sessions limitation to not detect multiple attached clients,
225225
thank you @timoses
226226

227227
## libtmux 0.10.1 (2021-06-16)
228228

229-
- Update `Window.select_window()` for {issue}`271`
229+
- Update `Window.select_window()` for #271
230230

231231
## libtmux 0.10.0 (2021-06-16)
232232

233-
- {issue}`321`: Convert to markdown
234-
- {issue}`271`: Fix {}`select_window()` by providing the session ID as
233+
- #321: Convert to markdown
234+
- #271: Fix {}`select_window()` by providing the session ID as
235235
argument to {}`-t`. Thanks @Flowdalic
236236
- Drop python 3.5 support
237237

238238
## libtmux 0.9.0 (2021-06-14)
239239

240240
Python 2.7 support dropped.
241241

242-
- {issue}`306`: chore: Remove python 2.7 support
243-
- {issue}`314`: chore: Python 3.x syntax tweaks
244-
- {issue}`312`: ci: Add tmux 3.2a to CI
242+
- #306: chore: Remove python 2.7 support
243+
- #314: chore: Python 3.x syntax tweaks
244+
- #312: ci: Add tmux 3.2a to CI
245245
- chore: Update black to [21.6b0](https://github.com/psf/black/blob/21.6b0/CHANGES.md#216b0)
246-
- {issue}`271`: Fix select_window() by providing the session ID as
246+
- #271: Fix select_window() by providing the session ID as
247247
argument to -t.
248248

249249
## libtmux 0.8.5 (2020-10-25)
250250

251-
- {issue}`297`: Enchance subprocess interaction std[in|out|err]. Needed
252-
for interact with big buffer, fixes {issue}`251`, thank you
251+
- #297: Enchance subprocess interaction std[in|out|err]. Needed
252+
for interact with big buffer, fixes #251, thank you
253253
@gil-obradors!
254-
- {issue}`303` Add `common.get_libtmux_version` which gives the tmux
254+
- #303 Add `common.get_libtmux_version` which gives the tmux
255255
version as a loose constraint. Fix linking to terms inside docs, and
256256
duplicate description of module which sphinx warned about in api.rst.
257-
- {issue}`266` Fix issue on local tests where env variables would cause
257+
- #266 Fix issue on local tests where env variables would cause
258258
show-environment to pause tests indefinitely.
259259

260260
## libtmux 0.8.4 (2020-10-25)
261261

262-
- {issue}`234`: `Window.split_window`: Allow passing `percent`, Thank
262+
- #234: `Window.split_window`: Allow passing `percent`, Thank
263263
you @jinankjain!
264-
- {issue}`289`: Fix warning due to invalid escape sequences, Thank you
264+
- #289: Fix warning due to invalid escape sequences, Thank you
265265
@tirkarthi!
266-
- {issue}`295`: Publish docs via our own action
267-
- {issue}`295`: Move more packaging over to poetry, though we'll keep
266+
- #295: Publish docs via our own action
267+
- #295: Move more packaging over to poetry, though we'll keep
268268
setup.py for the moment to ensure compatibility package maintainers.
269-
- {issue}`295`: New development instructions
270-
- {issue}`295`: Move doc/ to docs/
271-
- {issue}`296`: CI: Test python 2.7, cache python packages, prevent running
269+
- #295: New development instructions
270+
- #295: Move doc/ to docs/
271+
- #296: CI: Test python 2.7, cache python packages, prevent running
272272
internal PRs twice
273273

274274
## libtmux 0.8.3 (2020-08-16)
275275

276-
- {issue}`278`: Fix Python deprecation warnings, thanks @d1618033
276+
- #278: Fix Python deprecation warnings, thanks @d1618033
277277

278-
Also thanks Flowdalic for a similar PR at {issue}`294`
278+
Also thanks Flowdalic for a similar PR at #294
279279

280280
- Add `project_urls` to setup.py
281-
- {issue}`293` Move from Pipfile to poetry
281+
- #293 Move from Pipfile to poetry
282282
- Fix show_option test in tmux 3.0
283283
- Clean up handle_option_error comments
284284
- Move CI to a GitHub action
@@ -291,28 +291,28 @@ Python 2.7 support dropped.
291291

292292
## libtmux 0.8.1 (2019-01-26)
293293

294-
- {issue}`117` Fix issue with renaming clients with tmux 2.7 on BSD/macOS
294+
- #117 Fix issue with renaming clients with tmux 2.7 on BSD/macOS
295295
machines.
296-
- {issue}`121` Support `literal=True` (`-l`) in `Pane.send_keys`
296+
- #121 Support `literal=True` (`-l`) in `Pane.send_keys`
297297
from @ritiek
298-
- {issue}`131` Fix for unicode commands in Python 2, thanks @myw
299-
- {issue}`172` Support for next-X.Y versions from @sloria
300-
- {issue}`120` `capture_pane` support for `Pane`
301-
- {issue}`119` `display_message` support for `Pane`
298+
- #131 Fix for unicode commands in Python 2, thanks @myw
299+
- #172 Support for next-X.Y versions from @sloria
300+
- #120 `capture_pane` support for `Pane`
301+
- #119 `display_message` support for `Pane`
302302
- Sort imports with isort
303303
- Add sphinxcontrib-napoleon package for documentation
304304
- Move docstrings over to numpy's style
305305

306306
## libtmux 0.8.0 (2018-03-11)
307307

308-
- {issue}`46` Change license from BSD to MIT
308+
- #46 Change license from BSD to MIT
309309
- Move to new organization, tmux-python
310310
- Support package updates to pytest, sphinx, etc.
311311
- Travis/CI: Limit tests to Python 2.7 and 3.6 (removed 3.3 to 3.5)
312312
- Travis/CI: Update pypy veersions
313-
- {issue}`103` `Server.new_session` learned how to run commands in
313+
- #103 `Server.new_session` learned how to run commands in
314314
window on session start, thanks @grimpy!
315-
- {issue}`68` Make Server.has_session() use returncode, thanks
315+
- #68 Make Server.has_session() use returncode, thanks
316316
@jlargentaye! This should make `has_session` more robust.
317317

318318
## libtmux 0.7.8 (2018-03-04)
@@ -336,7 +336,7 @@ Python 2.7 support dropped.
336336

337337
## libtmux 0.7.4 (2017-08-19)
338338

339-
- {issue}`65` Add session id to commands, thanks [@askedrelic][@askedrelic]
339+
- #65 Add session id to commands, thanks [@askedrelic][@askedrelic]
340340

341341
## libtmux 0.7.3 (2017-05-29)
342342

@@ -348,7 +348,7 @@ Python 2.7 support dropped.
348348

349349
## libtmux 0.7.1 (2017-04-28)
350350

351-
- {issue}`37` Improve support for formatted options like
351+
- #37 Improve support for formatted options like
352352
`pane-border-status`. Thanks @kaushalmodi.
353353

354354
## libtmux 0.7.0 (2017-04-27)
@@ -383,23 +383,23 @@ Python 2.7 support dropped.
383383

384384
## libtmux 0.6.4 (2017-03-25)
385385

386-
- {issue}`32` support for OpenBSD's tmux
386+
- #32 support for OpenBSD's tmux
387387

388388
## libtmux 0.6.3 (2017-02-08)
389389

390-
- {issue}`25` support for working with tmux `master`, thanks @sloria.
390+
- #25 support for working with tmux `master`, thanks @sloria.
391391

392392
## libtmux 0.6.2 (2017-01-19)
393393

394-
- {issue}`197` use {}`LooseVersion` instead of {}`StrictVersion` for version
394+
- #197 use {}`LooseVersion` instead of {}`StrictVersion` for version
395395
checks. Thanks @minijackson.
396396
- Pin packages with pyup.io
397-
- {issue}`21` Readme fix from @huwenchao.
397+
- #21 Readme fix from @huwenchao.
398398

399399
## libtmux 0.6.1 (2016-12-20)
400400

401-
- {issue}`18` Fix logger, courtesy of @geekli
402-
- {issue}`19` Add support for `start_directory` in new sessions and
401+
- #18 Fix logger, courtesy of @geekli
402+
- #19 Add support for `start_directory` in new sessions and
403403
panes, courtesy of @gandelman-a.
404404
- Fix tests and add official support for 2.3
405405

@@ -412,14 +412,14 @@ Python 2.7 support dropped.
412412

413413
## libtmux 0.5.1 (2016-08-18)
414414

415-
- {issue}`12` - fix logger message when tmux doesn't exist in `PATH`
415+
- #12 - fix logger message when tmux doesn't exist in `PATH`
416416

417417
## libtmux 0.5 (2016-06-15)
418418

419-
- {issue}`8` new exception `UnknownOption`
420-
- {issue}`8` return `None` for options that are valid tmux options,
419+
- #8 new exception `UnknownOption`
420+
- #8 return `None` for options that are valid tmux options,
421421
but unset at that scope.
422-
- {issue}`6` major documentation overhaul
422+
- #6 major documentation overhaul
423423

424424
## libtmux 0.4.1 (2016-05-23)
425425

0 commit comments

Comments
 (0)