chore: Document functions in echo.lisp #685
Conversation
src/echo.lisp
Outdated
| Return t if success. | ||
|
|
||
| The first argument is a format control string, and the rest are data to be | ||
| formatted under control of the string." | ||
| (log-message string args) | ||
| (apply #'message-without-log string args) | ||
| t) |
There was a problem hiding this comment.
In Emacs, this function returns the string instead of t. WDYT? 🤔
There was a problem hiding this comment.
nice catch!
Probably a remnant of the practice of returning a T on success.
Since the purpose of this function is to display a message and not to return a value, (values) might be more appropriate.
There was a problem hiding this comment.
Sorry, I am still new to the development. What do you want me to change to accomplish? 🤔 Thanks!
There was a problem hiding this comment.
You may want to change t to (values)
The (values) means that no values are returned
(values 1 2 3) => 1, 2, 3 values
(values 1) => 1
(values) => No valueThere was a problem hiding this comment.
Ah! Learned new knowledge! Sorry, I was being dumb! Thank you!
Just updated the code! 🚀
There was a problem hiding this comment.
Thank you so much!
It is very helpful that you have written the documentation.
This patch also fixed some indentation issues.