Skip to content

Commit 069c272

Browse files
authored
Merge pull request #799 from CitrineInformatics/branch_docs_update
Update branch docs
2 parents 510dd64 + 5b67eb6 commit 069c272

File tree

2 files changed

+4
-27
lines changed

2 files changed

+4
-27
lines changed

docs/source/workflows/design_workflows.rst

Lines changed: 3 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -213,32 +213,9 @@ Thus, archiving all the design workflows contained within a branch will result i
213213
# Restore the branch to active status.
214214
my_branch = project.branches.restore(my_branch.uid) # my_branch.archived == False
215215
216-
You can also update the data on a branch similarly to the web application.
217-
To do so, first grab the available updates to a branch:
216+
You can also update the data on a branch similarly to the web application by using the ``update_data`` method on a :class:`~citrine.resources.branch.BranchCollection` with the desired arguments:
218217

219218
.. code:: python
220219
221-
# Retrieve any available data updates for a specific branch
222-
update = project.branches.data_updates(my_branch.uid)
223-
224-
Then construct an object of "instructions" for a branch using a :class:`~citrine.resources.data_version_update.NextBranchVersionRequest`:
225-
226-
.. code:: python
227-
228-
# Create a request that describes which predictors to use.
229-
# Leaving predictors empty will create new version of all predictors in that branch.
230-
from citrine.resources.data_version_update import NextBranchVersionRequest
231-
232-
request = NextBranchVersionRequest(
233-
data_updates=update.data_updates,
234-
use_predictors=[]
235-
)
236-
237-
Finally, create the next version of the branch with `next_version`:
238-
239-
.. code:: python
240-
241-
my_updated_branch = project.branches.next_version(
242-
branch_root_id = my_branch.root_id,
243-
branch_instructions=request
244-
)
220+
# Update the data on my_branch
221+
my_updated_branch = project.branches.update_data(branch=my_branch)

src/citrine/__version__.py

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

0 commit comments

Comments
 (0)