Merge pull request #74 from cadenmyers13/profile-docstring

doc: Example profile docstring

Author: sbillinge

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>

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