Improve docblocks for creating new subscriptions

Relates to issue #23
platformsh · Mar 14, 2018 · d3531d5 · d3531d5
1 parent d43baee
commit d3531d5
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/src/Model/Subscription.php b/src/Model/Subscription.php
@@ -37,6 +37,10 @@ class Subscription extends Resource
     /**
      * {@inheritdoc}
      *
+     * @internal Use PlatformClient::createSubscription() to create a new subscription.
+     *
+     * @see \Platformsh\Client\PlatformClient::createSubscription()
+     *
      * @return static
      */
     public static function create(array $body, $collectionUrl, ClientInterface $client)

diff --git a/src/PlatformClient.php b/src/PlatformClient.php
@@ -250,9 +250,13 @@ protected function cleanRequest(array $request)
      * @param int    $environments       The number of available environments.
      * @param array  $activationCallback An activation callback for the subscription.
      *
-     * @see PlatformClient::getRegions().
+     * @see PlatformClient::getRegions()
+     * @see Subscription::wait()
      *
      * @return Subscription
+     *   A subscription, representing a project. Use Subscription::wait() or
+     *   similar code to wait for the subscription's project to be provisioned
+     *   and activated.
      */
     public function createSubscription($region, $plan = 'development', $title = null, $storage = null, $environments = null, array $activationCallback = null)
     {