doc/index.html in contentful-1.2.2 vs doc/index.html in contentful-2.0.0

- old
+ new

@@ -76,10 +76,15 @@ platform for web applications, mobile apps and connected devices. It allows you to create, edit &amp; manage content in the cloud and publish it anywhere via powerful API. Contentful offers tools for managing editorial teams and enabling cooperation between organizations.</p> +<p><strong>IMPORTANT</strong>: We&#39;re collecting feedback before releasing +version 2.0.0 of the SDK, if you&#39;re interested in helping, please drop +by this issue and help us improving: <a +href="https://github.com/contentful/contentful.rb/issues/120">github.com/contentful/contentful.rb/issues/120</a></p> + <h2 id="label-Setup">Setup</h2> <p>Add to your Gemfile and bundle:</p> <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>contentful</span><span class='tstring_end'>&#39;</span></span> @@ -348,10 +353,23 @@ is 60 seconds. Keep in mind that if you hit the houly rate limit maximum, you can have up to 60 minutes of blocked requests. It is set to a default of 60 seconds in order to avoid blocking processes for too long, as rate limit retry behaviour is blocking per execution thread.</p> +<h3 id="label-3Amax_include_resolution_depth">:max_include_resolution_depth</h3> + +<p>Maximum amount of levels to resolve includes for SDK entities (this is +independent of API-level includes - it represents the maximum depth the +include resolution tree is allowed to resolved before falling back to +<code>Link</code> objects). This include resolution strategy is in place in +order to avoid having infinite circular recursion on resources with +circular dependencies. Defaults to 20. <em>Note</em>: If you&#39;re using +something like <code>Rails::cache</code> it&#39;s advisable to considerably +lower this value (around 5 has proven to be a good compromise - but keep it +higher or equal than your maximum API-level include parameter if you need +the entire tree resolution).</p> + <h3 id="label-Proxy+example">Proxy example</h3> <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'>Contentful</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='label'>access_token:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>b4c0n73n7fu1</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>space:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cfexampleapi</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> @@ -497,10 +515,10 @@ <p>Copyright © 2014 Contentful GmbH - Jan Lelis. See LICENSE.txt for further details.</p> </div></div> <div id="footer"> - Generated on Tue Jan 3 08:37:55 2017 by + Generated on Tue Mar 21 10:40:04 2017 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.5 (ruby-2.3.1). </div> </div> \ No newline at end of file