From d0b465ffd0299aea2b8fd832c402cc8e1f2bee1b Mon Sep 17 00:00:00 2001
From: Antoine M <amakdessi@me.com>
Date: Wed, 7 Feb 2024 10:10:05 +0100
Subject: [PATCH] chore(doc): add `_comment` documentation inside
 `composer.json` schema (#11825)

* Update 04-schema.md

* example
---
 doc/04-schema.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/doc/04-schema.md b/doc/04-schema.md
index 6bd169cf9..e36ec2111 100644
--- a/doc/04-schema.md
+++ b/doc/04-schema.md
@@ -967,6 +967,23 @@ Defaults to false.
 
 Optional.
 
+### _comment
+
+Top level key used as a place to store comments (it can be a string or array of strings).
+
+```json
+{
+    "_comment": [
+        "The package foo/bar was required for business logic",
+        "Remove package foo/baz when removing foo/bar"
+    ]
+}
+```
+
+Defaults to empty.
+
+Optional.
+
 ### non-feature-branches
 
 A list of regex patterns of branch names that are non-numeric (e.g. "latest" or something),