chore: reword the changelog fragments, add break entry type

pdm-project · Jun 29, 2022 · 54f150f · 54f150f
1 parent 7350fd4
commit 54f150f
Show file tree

Hide file tree

Showing 16 changed files with 15 additions and 16 deletions.
diff --git a/news/1072.dep.md b/news/1072.dep.md
@@ -1 +1 @@
-Prefer tomllib on Python 3.11
+Prefer `tomllib` on Python 3.11
diff --git a/news/1083.break.md b/news/1083.break.md
@@ -0,0 +1 @@
+Editable dependencies in the `[project]` table is not allowed, according to PEP 621. They are however still allowed in the `[tool.pdm.dev-dependencies]` table. PDM will emit a warning when it finds editable dependencies in the `[project]` table, or will abort when you try to add them into the `[project]` table via CLI.
diff --git a/news/1083.feature.md b/news/1083.feature.md
diff --git a/news/1091.misc.md b/news/1091.misc.md
diff --git a/news/1096.feature.md → news/1096.feature.1.md b/news/1096.feature.md → news/1096.feature.1.md
diff --git a/news/1096.refactor.md → news/1096.feature.2.md b/news/1096.refactor.md → news/1096.feature.2.md
diff --git a/news/1098.feature.md b/news/1098.feature.md
@@ -1 +1 @@
-Lazy load the candidates returned by `find_matches()` to speed up the resolution.
+Lazily load the candidates returned by `find_matches()` to speed up the resolution.
diff --git a/news/1153.dep.md b/news/1153.dep.md
@@ -1 +1 @@
-Update dependency version `pdm-pep517` to 1.0.0.
+Update dependency version `pdm-pep517` to `1.0.0`.
diff --git a/news/1156.feature.md b/news/1156.feature.md
@@ -0,0 +1 @@
+Retrieve the candidate metadata by parsing the `pyproject.toml` rather than building it.
diff --git a/news/1156.fix.md b/news/1156.fix.md
diff --git a/news/1157.feature.md b/news/1157.feature.md
@@ -1 +1 @@
-Update the converters to support the new `[tool.pdm.build]` table.
+Update the format converters to support the new `[tool.pdm.build]` table.
diff --git a/news/1160.misc.md b/news/1160.misc.md
@@ -1 +1 @@
-Provides a `tox.ini` file for easier local testing against all Python versions.
+Provide a `tox.ini` file for easier local testing against all Python versions.
diff --git a/news/1161.break.md b/news/1161.break.md
@@ -0,0 +1 @@
+Now the paths to the global configurations and global project are calculated according to platform standards.
diff --git a/news/1161.fix.md b/news/1161.fix.md
diff --git a/news/593.feature.md b/news/593.feature.md
@@ -1 +1 @@
-Configuration item to respect the source order in the `pyproject.toml` file. Packages will be returned by source earlier in the order or later ones if not found.
+Add project configuration `respect-source-order` under `[tool.pdm.resolution]` to respect the source order in the `pyproject.toml` file. Packages will be returned by source earlier in the order or later ones if not found.
diff --git a/pyproject.toml b/pyproject.toml
@@ -125,6 +125,11 @@ title_format = "Release v{version} ({project_date})"
 template = "news/towncrier_template.md"
 underlines = "-~^"
 
+  [[tool.towncrier.type]]
+  directory = "break"
+  name = "Breaking Changes"
+  showcontent = true
+
   [[tool.towncrier.type]]
   directory = "feature"
   name = "Features & Improvements"
@@ -137,7 +142,7 @@ underlines = "-~^"
 
   [[tool.towncrier.type]]
   directory = "doc"
-  name = "Improved Documentation"
+  name = "Documentation"
   showcontent = true
 
   [[tool.towncrier.type]]
@@ -155,11 +160,6 @@ underlines = "-~^"
   name = "Miscellany"
   showcontent = true
 
-  [[tool.towncrier.type]]
-  directory = "refactor"
-  name = "Refactor"
-  showcontent = true
-
 [build-system]
 requires = ["pdm-pep517>=1.0"]
 build-backend = "pdm.pep517.api"
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		Prefer tomllib on Python 3.11
		Prefer `tomllib` on Python 3.11
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Editable dependencies in the `[project]` table is not allowed, according to PEP 621. They are however still allowed in the `[tool.pdm.dev-dependencies]` table. PDM will emit a warning when it finds editable dependencies in the `[project]` table, or will abort when you try to add them into the `[project]` table via CLI.
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		Lazy load the candidates returned by `find_matches()` to speed up the resolution.
		Lazily load the candidates returned by `find_matches()` to speed up the resolution.
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		Update dependency version `pdm-pep517` to 1.0.0.
		Update dependency version `pdm-pep517` to `1.0.0`.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Retrieve the candidate metadata by parsing the `pyproject.toml` rather than building it.
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		Update the converters to support the new `[tool.pdm.build]` table.
		Update the format converters to support the new `[tool.pdm.build]` table.
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		Provides a `tox.ini` file for easier local testing against all Python versions.
		Provide a `tox.ini` file for easier local testing against all Python versions.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Now the paths to the global configurations and global project are calculated according to platform standards.
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		Configuration item to respect the source order in the `pyproject.toml` file. Packages will be returned by source earlier in the order or later ones if not found.
		Add project configuration `respect-source-order` under `[tool.pdm.resolution]` to respect the source order in the `pyproject.toml` file. Packages will be returned by source earlier in the order or later ones if not found.