Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 7ef1f7e

Browse files
bearomorphismLee-W
authored andcommitted
docs(bump.md): add titles to code blocks and fix minor grammar issues
1 parent f80292e commit 7ef1f7e

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

docs/commands/bump.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ cz bump --version-scheme semver
3131
```
3232

3333
2. Configuration file:
34-
```toml
34+
```toml title="pyproject.toml"
3535
[tool.commitizen]
3636
version_scheme = "semver"
3737
```
@@ -113,7 +113,7 @@ Note that as per [semantic versioning spec](https://semver.org/#spec-item-9)
113113
For example, the following versions (using the [PEP 440](https://peps.python.org/pep-0440/) scheme) are ordered
114114
by their precedence and showcase how a release might flow through a development cycle:
115115

116-
- `1.0.0` is the current published version
116+
- `1.0.0` is the currently published version
117117
- `1.0.1a0` after committing a `fix:` for pre-release
118118
- `1.1.0a1` after committing an additional `feat:` for pre-release
119119
- `1.1.0b0` after bumping a beta release
@@ -153,7 +153,7 @@ cz bump --check-consistency
153153

154154
For example, if we have `pyproject.toml`
155155

156-
```toml
156+
```toml title="pyproject.toml"
157157
[tool.commitizen]
158158
version = "1.21.0"
159159
version_files = [
@@ -162,15 +162,16 @@ version_files = [
162162
]
163163
```
164164

165-
`src/__version__.py`,
165+
`src/__version__.py`
166166

167-
```python
167+
168+
```python title="src/__version__.py"
168169
__version__ = "1.21.0"
169170
```
170171

171-
and `setup.py`.
172+
and `setup.py`
172173

173-
```python
174+
```python title="setup.py"
174175
from setuptools import setup
175176

176177
setup(..., version="1.0.5", ...)
@@ -193,7 +194,7 @@ cz bump --local-version
193194

194195
For example, if we have `pyproject.toml`
195196

196-
```toml
197+
```toml title="pyproject.toml"
197198
[tool.commitizen]
198199
version = "5.3.5+0.1.0"
199200
```
@@ -454,7 +455,7 @@ In your `pyproject.toml` or `.cz.toml`
454455
tag_format = "v$major.$minor.$patch$prerelease"
455456
```
456457

457-
The variables must be preceded by a `$` sign and optionally can be wrapped in `{}` . Default is `$version`.
458+
The variables must be preceded by a `$` sign and optionally can be wrapped in `{}`. The default is `$version`.
458459

459460
Supported variables:
460461

@@ -483,7 +484,7 @@ Some examples
483484

484485
`pyproject.toml`, `.cz.toml` or `cz.toml`
485486

486-
```toml
487+
```toml title="pyproject.toml"
487488
[tool.commitizen]
488489
version_files = [
489490
"src/__version__.py",
@@ -496,8 +497,7 @@ This means that it will find a file `setup.py` and will only make a change
496497
in a line containing the `version` substring.
497498

498499
!!! note
499-
Files can be specified using relative (to the execution) paths, absolute paths
500-
or glob patterns.
500+
Files can be specified using relative (to the execution) paths, absolute paths, or glob patterns.
501501

502502
---
503503

@@ -516,7 +516,7 @@ Some examples
516516

517517
`pyproject.toml`, `.cz.toml` or `cz.toml`
518518

519-
```toml
519+
```toml title="pyproject.toml"
520520
[tool.commitizen]
521521
bump_message = "release $current_version → $new_version [skip-ci]"
522522
```
@@ -529,7 +529,7 @@ When set to `true` the changelog is always updated incrementally when running `c
529529

530530
Defaults to: `false`
531531

532-
```toml
532+
```toml title="pyproject.toml"
533533
[tool.commitizen]
534534
update_changelog_on_bump = true
535535
```
@@ -540,7 +540,7 @@ update_changelog_on_bump = true
540540

541541
When set to `true`, Commitizen will create annotated tags.
542542

543-
```toml
543+
```toml title="pyproject.toml"
544544
[tool.commitizen]
545545
annotated_tag = true
546546
```
@@ -551,7 +551,7 @@ annotated_tag = true
551551

552552
When set to `true`, Commitizen will create gpg signed tags.
553553

554-
```toml
554+
```toml title="pyproject.toml"
555555
[tool.commitizen]
556556
gpg_sign = true
557557
```
@@ -565,7 +565,7 @@ Useful during the initial development stage of your project.
565565

566566
Defaults to: `false`
567567

568-
```toml
568+
```toml title="pyproject.toml"
569569
[tool.commitizen]
570570
major_version_zero = true
571571
```
@@ -591,7 +591,7 @@ execution of the script, some environment variables are available:
591591
| `CZ_PRE_INCREMENT` | Whether this is a `MAJOR`, `MINOR` or `PATH` release |
592592
| `CZ_PRE_CHANGELOG_FILE_NAME` | Path to the changelog file, if available |
593593

594-
```toml
594+
```toml title="pyproject.toml"
595595
[tool.commitizen]
596596
pre_bump_hooks = [
597597
"scripts/generate_documentation.sh"
@@ -618,7 +618,7 @@ release. During execution of the script, some environment variables are availabl
618618
| `CZ_POST_INCREMENT` | Whether this was a `MAJOR`, `MINOR` or `PATH` release |
619619
| `CZ_POST_CHANGELOG_FILE_NAME` | Path to the changelog file, if available |
620620

621-
```toml
621+
```toml title="pyproject.toml"
622622
[tool.commitizen]
623623
post_bump_hooks = [
624624
"scripts/slack_notification.sh"
@@ -631,7 +631,7 @@ Offset with which to start counting prereleases.
631631

632632
Defaults to: `0`
633633

634-
```toml
634+
```toml title="pyproject.toml"
635635
[tool.commitizen]
636636
prerelease_offset = 1
637637
```
@@ -651,7 +651,7 @@ Options: `pep440`, `semver`, `semver2`
651651

652652
Defaults to: `pep440`
653653

654-
```toml
654+
```toml title="pyproject.toml"
655655
[tool.commitizen]
656656
version_scheme = "semver"
657657
```

0 commit comments

Comments
 (0)