From dbcc8500a8d0fe9002e6d80fa8d4e0de090969c4 Mon Sep 17 00:00:00 2001
From: Caden Myers <cjm2304@columbia.edu>
Date: Thu, 6 Nov 2025 10:01:38 -0500
Subject: [PATCH 1/2] profile format docstring

---
 src/diffpy/cmi/profilesmanager.py | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/src/diffpy/cmi/profilesmanager.py b/src/diffpy/cmi/profilesmanager.py
index 533b239..eee2826 100644
--- a/src/diffpy/cmi/profilesmanager.py
+++ b/src/diffpy/cmi/profilesmanager.py
@@ -45,6 +45,19 @@ class Profile:
         Extra requirement lines (scripts or packages).
     source : path-like
         Absolute path to the YAML file that defined the profile.
+
+    Profile Format
+    --------------
+    All profile `.yaml` files must have the following structure::
+
+        packs:
+            - <pack_name>
+
+        extras:
+            - <additional_package_name>
+
+    The file name is the profile identifier used for installing profiles.
+    See `requirements/profiles/all.yml` for an example.
     """
 
     name: str

From dca7577b0348425aec64e0f037ca1d40f63f7e8e Mon Sep 17 00:00:00 2001
From: Caden Myers <cjm2304@columbia.edu>
Date: Thu, 6 Nov 2025 10:02:07 -0500
Subject: [PATCH 2/2] news

---
 news/profile-docstring.rst | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 news/profile-docstring.rst

diff --git a/news/profile-docstring.rst b/news/profile-docstring.rst
new file mode 100644
index 0000000..de444e5
--- /dev/null
+++ b/news/profile-docstring.rst
@@ -0,0 +1,23 @@
+**Added:**
+
+* No news added.
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>