Merge pull request #5 from phel-lang/fix/issue-3

doc: add note about return value of `statement/execute` #3
phel-lang · Dec 29, 2024 · 5639184 · 5639184
2 parents cac6791 + 9245f88
commit 5639184
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 ### Bugfix
 
  * rename keyowrd -> keyword #2 (@jasalt)
+ * doc: add note about return value of `statement/execute` #3
 
 ## v0.0.7 (2024-06-24)
 

diff --git a/README.md b/README.md
@@ -199,6 +199,9 @@ Returns an SQL prepared command
 
 Executes a prepared statement
 
+> [!NOTE]
+> The return value of the original library, `PDOStatement::execute()`, is a `bool` value representing the result of the `execute` method, while the return value of `statement/execute` returns the statement itself.
+
 ```clojure
 (execute statement)
 ```