From: Jeremy Benoist <jeremy.benoist@gmail.com>
Date: Wed, 24 May 2017 14:02:49 +0000 (+0200)
Subject: Improve docs
X-Git-Tag: 2.3.0~31^2~79^2~4
X-Git-Url: https://git.immae.eu/?a=commitdiff_plain;h=9e349f08a651c43c6d5dd890303ed529c38c4fde;p=github%2Fwallabag%2Fwallabag.git

Improve docs
---

diff --git a/src/Wallabag/ApiBundle/Controller/EntryRestController.php b/src/Wallabag/ApiBundle/Controller/EntryRestController.php
index 0930c109..cc2cca64 100644
--- a/src/Wallabag/ApiBundle/Controller/EntryRestController.php
+++ b/src/Wallabag/ApiBundle/Controller/EntryRestController.php
@@ -273,6 +273,9 @@ class EntryRestController extends WallabagRestController
     /**
      * Create an entry.
      *
+     * If you want to provide the HTML content (which means wallabag won't fetch it from the url), you must provide `content`, `title` & `url` fields **non-empty**.
+     * Otherwise, content will be fetched as normal from the url and values will be overwritten.
+     *
      * @ApiDoc(
      *       parameters={
      *          {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
diff --git a/src/Wallabag/CoreBundle/Helper/ContentProxy.php b/src/Wallabag/CoreBundle/Helper/ContentProxy.php
index 66d72fe6..90d0c50d 100644
--- a/src/Wallabag/CoreBundle/Helper/ContentProxy.php
+++ b/src/Wallabag/CoreBundle/Helper/ContentProxy.php
@@ -31,7 +31,7 @@ class ContentProxy
     }
 
     /**
-     * Fetch content using graby and hydrate given entry with results information.
+     * Fetch content using graby and hydrate given $entry with results information.
      * In case we couldn't find content, we'll try to use Open Graph data.
      *
      * We can also force the content, in case of an import from the v1 for example, so the function won't
@@ -39,7 +39,7 @@ class ContentProxy
      *
      * @param Entry  $entry   Entry to update
      * @param string $url     Url to grab content for
-     * @param array  $content An array with AT LEAST keys title, html, url, language & content_type to skip the fetchContent from the url
+     * @param array  $content An array with AT LEAST keys title, html, url to skip the fetchContent from the url
      *
      * @return Entry
      */
@@ -85,7 +85,7 @@ class ContentProxy
             try {
                 $entry->setPublishedAt(new \DateTime($content['date']));
             } catch (\Exception $e) {
-                $this->logger->warn('Error while defining date', ['e' => $e, 'url' => $url, 'date' => $content['date']]);
+                $this->logger->warning('Error while defining date', ['e' => $e, 'url' => $url, 'date' => $content['date']]);
             }
         }