Skip to content

Commit 68aac09

Browse files
authored
Merge pull request #760 from CitrineInformatics/branch_docs_update
Branch docs update
2 parents d04650d + e1a8293 commit 68aac09

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

docs/source/workflows/design_workflows.rst

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,9 +146,14 @@ For example:
146146
Branches
147147
--------
148148

149-
Branches are purely an organizational concept, used to group design workflows under a single name. If you do not wish to interact with them, ignore the ``branch_id`` on a DesignWorkflow, and it will be handled for you.
149+
Branches are purely an organizational concept, used to group design workflows with similar goals under a single name.
150+
They are the primary organizational concept of AI assets as displayed in our web UI.
151+
In the context of the Citrine Python client, they can be thought of as a bucket of design workflows.
152+
If you do not wish to interact with them in the python client, ignore the ``branch_id`` on a DesignWorkflow, and it will be handled for you.
150153

151-
A branch has a name, along with any number of design workflows. A DesignWorkflow can be created and retrieved, and you can list all design workflows on a branch. You can still list all design workflows on the project as before.
154+
A branch has a name, along with any number of design workflows.
155+
A DesignWorkflow can be created and retrieved, and you can list all design workflows on a branch.
156+
You can still list all design workflows on the project as before.
152157

153158
.. code:: python
154159
@@ -183,6 +188,14 @@ A branch has a name, along with any number of design workflows. A DesignWorkflow
183188
When you're done with a branch, it can be archived, removing it from the results of ``list`` and setting the ``archived`` flag.
184189
``list_archived`` lists all archived branches in a project. An archived branch can be restored via its unique ID.
185190

191+
Note that archiving branches is independent of archiving the design workflows contained within it.
192+
Archiving a branch will hide the entire branch from default displays in the web UI.
193+
As a result, the design workflows it contained within it will also be hidden.
194+
Yet archiving th branch will *not* change the archived status of the contained design workflows in the context of design workflow listing methods.
195+
196+
Similarly, archiving a design workflow will result in its executions and relevant assets no longer being displayed within the branch.
197+
Thus, archiving all the design workflows contained within a branch will result in a hidden branch on the web UI, but the archival status of the branch will not change.
198+
186199
.. code:: python
187200
188201
# Display whether your branch is archived.

src/citrine/__version__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = '1.32.0'
1+
__version__ = '1.32.1'

0 commit comments

Comments
 (0)