Skip to content

doc: Example profile docstring #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 6, 2025
Merged

doc: Example profile docstring #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dbcc850
profile format docstring
cadenmyers13 Nov 6, 2025
dca7577
news
cadenmyers13 Nov 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions news/profile-docstring.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* No news added.

**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>
13 changes: 13 additions & 0 deletions src/diffpy/cmi/profilesmanager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading