launchpad-reviewers team mailing list archive

[Colin Watson <cjwatson@xxxxxxxxxxxxx>]

Colin Watson has proposed merging lp:~cjwatson/launchpad/snap-requestBuilds-doc into lp:launchpad.

Commit message:
Fix the documentation of Snap.requestBuilds.

Requested reviews:
  Launchpad code reviewers (launchpad-reviewers)

For more details, see:
https://code.launchpad.net/~cjwatson/launchpad/snap-requestBuilds-doc/+merge/358466

Snap.getRequestedBuilds existed in an early draft of the snap build request interface, but I replaced it with the exported ISnapBuildRequest before landing it.
-- 
Your team Launchpad code reviewers is requested to review the proposed merge of lp:~cjwatson/launchpad/snap-requestBuilds-doc into lp:launchpad.

=== modified file 'lib/lp/snappy/interfaces/snap.py'
--- lib/lp/snappy/interfaces/snap.py	2018-10-09 09:25:19 +0000
+++ lib/lp/snappy/interfaces/snap.py	2018-11-07 22:47:29 +0000
@@ -419,9 +419,9 @@
     def requestBuilds(requester, archive, pocket, channels=None):
         """Request that the snap package be built for relevant architectures.
 
-        This is an asynchronous operation, and returns a job ID which can be
-        passed to `snap.getRequestedBuilds`; once the operation has
-        finished, that method will return the resulting builds.
+        This is an asynchronous operation; once the operation has finished,
+        the resulting build request's C{status} will be "Completed" and its
+        C{builds} collection will return the resulting builds.
 
         :param requester: The person requesting the builds.
         :param archive: The IArchive to associate the builds with.