patx/pickledb

Revise load method return type in documentation

Commit 3e8c289 · Harrison Erd · 2026-01-04T23:50:53-05:00

Changeset

3e8c28937b4bbfeb51c03617f1a915a46a57017a

Parents

3c97641dfb5b3bc58b36e58ee7f1fd3ca31f5c61

View source at this commit

Revise load method return type in documentation

Updated the load method documentation to reflect that it returns the database instance for method chaining instead of a boolean. Note self is still truthy so should be backwards compatible.

Comments

No comments yet.

Log in to comment

Diff

diff --git a/docs/index.html b/docs/index.html
index 617dffb..24ea934 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1057,7 +1057,7 @@ asyncio.run(main())</code></pre>
 
           <div class="api-method">
             <div class="api-signature">
-              <code>load() -&gt; bool</code>
+              <code>load() -&gt; self</code>
               <div class="api-tags">
                 <span class="api-tag">sync</span>
                 <span class="api-tag">async</span>
@@ -1069,7 +1069,7 @@ asyncio.run(main())</code></pre>
             <ul class="api-usage">
               <li><strong>Sync:</strong> <code>db.load()</code></li>
               <li><strong>Async:</strong> <code>await db.load()</code></li>
-              <li>Returns <code>True</code> on success.</li>
+              <li>Returns the database instance itself, allowing method chaining.</li>
             </ul>
           </div>