Skip to content

Commit 1ddf1f0

Browse files
committed
docs(CHANGES): Linkify issues and note the settings are experimental
1 parent 5c55477 commit 1ddf1f0

File tree

1 file changed

+41
-26
lines changed

1 file changed

+41
-26
lines changed

CHANGES

Lines changed: 41 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,15 @@ $ pipx install --suffix=@next 'tmuxp' --pip-args '\--pre' --force
2121

2222
### What's new
2323

24-
- #747: Skip execution via `enter: false`
24+
- {issue}`747`: Skip execution via `enter: false`
25+
26+
See {ref}`enter`.
27+
28+
:::{note}
29+
30+
_Experimental setting_: behavior and api is subject to change until stable.
31+
32+
:::
2533

2634
```yaml
2735
session_name: Should not execute
@@ -37,7 +45,15 @@ $ pipx install --suffix=@next 'tmuxp' --pip-args '\--pre' --force
3745
enter: false
3846
```
3947
40-
- #750: Pause execution via `sleep_before: [int]` and `sleep_after: [int]`
48+
- {issue}`750`: Pause execution via `sleep_before: [int]` and `sleep_after: [int]`
49+
50+
See {ref}`sleep`.
51+
52+
:::{note}
53+
54+
_Experimental setting_: behavior and api is subject to change until stable.
55+
56+
:::
4157

4258
```yaml
4359
session_name: Pause / skip command execution (command-level)
@@ -58,7 +74,7 @@ $ pipx install --suffix=@next 'tmuxp' --pip-args '\--pre' --force
5874
- cmd: echo "2 seconds later"
5975
```
6076

61-
- #701: `tmuxp freeze` now accepts `--quiet` and `--yes` along with the
77+
- {issue}`701`: `tmuxp freeze` now accepts `--quiet` and `--yes` along with the
6278
`--config-format` and filename (`--save-to`). This means you can do it all in
6379
one command:
6480

@@ -68,7 +84,7 @@ $ pipx install --suffix=@next 'tmuxp' --pip-args '\--pre' --force
6884

6985
Credit: [@davidatbu](https://github.com/davidatbu)
7086

71-
- #672: Panes now accept `shell` for their initial command.
87+
- {issue}`672`: Panes now accept `shell` for their initial command.
7288

7389
Equivalent to `tmux split-windows`'s `[shell-command]`
7490

@@ -101,19 +117,19 @@ $ pipx install --suffix=@next 'tmuxp' --pip-args '\--pre' --force
101117
102118
### Improvements
103119
104-
- Improve `tmuxp freeze` UX flow, credit @joseph-flinn (#657, in re: #627)
120+
- Improve `tmuxp freeze` UX flow, credit @joseph-flinn ({issue}`657`, in re: {issue}`627`)
105121
- `tmuxp freeze` will now detect the attached session if no session name
106-
is specified. Credit: @will-ockmore. (#660)
122+
is specified. Credit: @will-ockmore. ({issue}`660`)
107123

108124
### Bugs
109125

110-
- Fix loading of `.yml` files with `tmuxp convert`, thank you @kalixi! (#725)
126+
- Fix loading of `.yml` files with `tmuxp convert`, thank you @kalixi! ({issue}`725`)
111127

112128
### Internal API
113129

114-
- #752: Command structure (internal API)
130+
- {issue}`752`: Command structure (internal API)
115131

116-
To pave the way for per-command options such as `enter: false` (#53), commands are now a different format:
132+
To pave the way for per-command options such as `enter: false` ({issue}`53`), commands are now a different format:
117133

118134
Before, [`str`](str):
119135

@@ -132,13 +148,13 @@ $ pipx install --suffix=@next 'tmuxp' --pip-args '\--pre' --force
132148
This is purely internal. Normal usage should be the same since the
133149
configuration emits the equivalent result.
134150

135-
- #752: Configuration parsing refactorings
151+
- {issue}`752`: Configuration parsing refactorings
136152

137153
### Development
138154

139-
- Run through black + isort with string normalization (#738). This way we can
155+
- Run through black + isort with string normalization ({issue}`738`). This way we can
140156
use black without any configuration. (One-time, big diff)
141-
- Run codebase through pyupgrade (#745)
157+
- Run codebase through pyupgrade ({issue}`745`)
142158
- Add `codeql-analysis.yml` to try it out
143159

144160
### Documentation
@@ -151,49 +167,48 @@ $ pipx install --suffix=@next 'tmuxp' --pip-args '\--pre' --force
151167

152168
### Packaging
153169

154-
- `poetry build` used to package in place of `python setup.py build` (#729)
170+
- `poetry build` used to package in place of `python setup.py build` ({issue}`729`)
155171

156-
Package maintainers: If you run into any issues check in at
157-
[#625](https://github.com/tmux-python/tmuxp/issues/625) and file an issue.
172+
Package maintainers: If you run into any issues check in at {issue}`625` and file an issue.
158173

159174
Additionally, `libtmux` has been pinned to a similar release at
160175
[0.10.3](https://pypi.org/project/libtmux/0.10.3/) which has used the new
161176
build process.
162177

163-
- `poetry publish` instead of `twine upload dist/*` (#729)
178+
- `poetry publish` instead of `twine upload dist/*` ({issue}`729`)
164179

165-
Similar to the above, reach out to the #625 issue if you bump into problems.
180+
Similar to the above, reach out to the {issue}`625` issue if you bump into problems.
166181

167182
### What's new
168183

169-
- `tmuxp edit` for configuration changes (#707, @GlebPoljakov)
184+
- `tmuxp edit` for configuration changes ({issue}`707`, @GlebPoljakov)
170185

171186
Inside of configuration directory: `tmuxp edit yourconfig`
172187

173188
Inside a project: `tmuxp edit .`
174189

175190
### Removed support
176191

177-
- Python 3.6 support has been removed (#726)
192+
- Python 3.6 support has been removed ({issue}`726`)
178193

179194
### Development
180195

181196
- We are trying `.pre-commit-config.yaml` in pull requests to automate
182-
black, isort and flake8 for those who forget (#726)
183-
- Poetry update 1.1.7 -> 1.1.12 and use new installer URL (#726)
184-
- Black updated 21.9b0 -> 21.12b0 (#726)
197+
black, isort and flake8 for those who forget ({issue}`726`)
198+
- Poetry update 1.1.7 -> 1.1.12 and use new installer URL ({issue}`726`)
199+
- Black updated 21.9b0 -> 21.12b0 ({issue}`726`)
185200

186201
## tmuxp 1.9.3 (2021-10-30)
187202

188-
- #700: Add `-h` / `--help` option, thanks @GHPS
189-
- #689: Update poetry to 1.1
203+
- {issue}`700`: Add `-h` / `--help` option, thanks @GHPS
204+
- {issue}`689`: Update poetry to 1.1
190205
- CI: Use poetry 1.1.7 and `install-poetry.py` installer
191206
- Relock poetry.lock at 1.1 (w/ 1.1.7's fix)
192-
- #696: Typo fix, thanks @inkch
207+
- {issue}`696`: Typo fix, thanks @inkch
193208

194209
## tmuxp 1.9.2 (2021-06-17)
195210

196-
- #686: Allow click 8.0.x
211+
- {issue}`686`: Allow click 8.0.x
197212
- Remove `manual/`, move to https://github.com/tmux-python/tmux-manuals
198213

199214
## tmuxp 1.9.1 (2021-06-16)

0 commit comments

Comments
 (0)