Skip to content

Commit c0da2e6

Browse files
committed
docs: fix some format issues in docs
1 parent 1e5869e commit c0da2e6

File tree

2 files changed

+19
-11
lines changed

2 files changed

+19
-11
lines changed

docs/config/bump.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -185,24 +185,24 @@ version_files = [
185185

186186
```json title="setup.json"
187187
{
188-
"name": "magictool",
189-
"version": "1.2.3",
190-
"dependencies": {
191-
"lodash": "1.2.3"
192-
}
188+
"name": "magictool",
189+
"version": "1.2.3",
190+
"dependencies": {
191+
"lodash": "1.2.3"
192+
}
193193
}
194194
```
195195

196196
After running `cz bump 2.0.0`, its content will be updated to:
197197

198198
```diff title="setup.json"
199199
{
200-
"name": "magictool",
201-
- "version": "1.2.3",
202-
+ "version": "2.0.0",
203-
"dependencies": {
204-
"lodash": "1.2.3"
205-
}
200+
"name": "magictool",
201+
- "version": "1.2.3",
202+
+ "version": "2.0.0",
203+
"dependencies": {
204+
"lodash": "1.2.3"
205+
}
206206
}
207207
```
208208

docs/config/version_provider.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Commitizen includes several built-in version providers for common package manage
1919
The default version provider stores and retrieves the version from your Commitizen configuration file (e.g., `pyproject.toml`, `.cz.toml`, etc.).
2020

2121
**Use when:**
22+
2223
- You want to keep version management separate from your package manager
2324
- Your project doesn't use a standard package manager
2425
- You need maximum flexibility in version management
@@ -35,6 +36,7 @@ version = "0.1.0" # Required when using this provider
3536
Fetches the version from Git tags using `git describe`. This provider **only reads** version information and never writes it back to files. It's designed to work with tools like `setuptools-scm` or other package manager `*-scm` plugins that derive version numbers from Git history.
3637

3738
**Use when:**
39+
3840
- You're using `setuptools-scm` or similar tools
3941
- You want version numbers derived from Git tags
4042
- You don't want Commitizen to modify any files for version management
@@ -54,6 +56,7 @@ version_provider = "scm"
5456
Manages version in `pyproject.toml` under the `project.version` field, following [PEP 621](https://peps.python.org/pep-0621/) standards.
5557

5658
**Use when:**
59+
5760
- You're using a modern Python project with PEP 621-compliant `pyproject.toml`
5861
- You want version management integrated with your Python project metadata
5962

@@ -75,6 +78,7 @@ version = "0.1.0" # Managed by Commitizen
7578
Manages version in `pyproject.toml` under the `tool.poetry.version` field, which is used by the [Poetry](https://python-poetry.org/) package manager. This approach is recommended only for users running Poetry versions earlier than 2.0 or relying on Poetry-specific features. For most users on Poetry 2.0 or later, it is recommended to use `pep621` instead. [Read More](https://python-poetry.org/docs/main/managing-dependencies/)
7679

7780
**Use when:**
81+
7882
- You're using Poetry < 2.0 as your Python package manager
7983
- You're using Poetry >= 2.0 as your Python package manager, but don't need poetry-specific features
8084
- You want Commitizen to manage the version that Poetry uses
@@ -101,6 +105,7 @@ Manages version in both `pyproject.toml` (`project.version`) and `uv.lock` (`pac
101105
Even though uv follows PEP 621 format, `pep621` does not manage the version in `uv.lock`. `uv` is still suggested for uv users.
102106

103107
**Use when:**
108+
104109
- You're using `uv` as your Python package manager
105110
- You want version synchronization between `pyproject.toml` and `uv.lock`
106111

@@ -115,6 +120,7 @@ version_provider = "uv"
115120
Manages version in both `Cargo.toml` (`package.version`) and `Cargo.lock` (`package.version` for the matching package name). This ensures consistency between your Rust project's manifest and lock file.
116121

117122
**Use when:**
123+
118124
- You're working with a Rust project using Cargo
119125
- You want Commitizen to manage Rust package versions
120126

@@ -136,6 +142,7 @@ version = "0.1.0" # Managed by Commitizen
136142
Manages version in `package.json` and optionally synchronizes with `package-lock.json` and `npm-shrinkwrap.json` if they exist.
137143

138144
**Use when:**
145+
139146
- You're working with a Node.js/JavaScript project
140147
- You want Commitizen to manage npm package versions
141148

@@ -158,6 +165,7 @@ version_provider = "npm"
158165
Manages version in `composer.json` under the `version` field, used by PHP's Composer package manager.
159166

160167
**Use when:**
168+
161169
- You're working with a PHP project using Composer
162170
- You want Commitizen to manage Composer package versions
163171

0 commit comments

Comments
 (0)