From: Daniel Kraus <daniel@kraus.my>
To: Ihor Radchenko <yantar92@posteo.net>
Cc: emacs-orgmode@gnu.org
Subject: Re: [patch] ob-clojure: Fix results output
Date: Thu, 23 Mar 2023 12:31:56 +0100 [thread overview]
Message-ID: <87mt43em3k.fsf@kraus.my> (raw)
In-Reply-To: <877cv9oye2.fsf@localhost>
Ihor Radchenko <yantar92@posteo.net> writes:
> Now, the docstring appears to be a bit confusing:
>
> (defun ob-clojure-eval-with-cider (expanded _params &optional cljs-p)
> "Evaluate EXPANDED code block with PARAMS using cider.
> When CLJS-P is non-nil, use a cljs connection instead of clj."
>
> It would be useful to mention that PARAMS argument is unused.
Should I go with your initial suggestion and just replace it with _?
Like
(defun ob-clojure-eval-with-cider (expanded _ &optional cljs-p)
"Evaluate EXPANDED code block using cider.
When CLJS-P is non-nil, use a cljs connection instead of clj."
But then someone will maybe wonder why there is unused argument?
Or rather something like:
(defun ob-clojure-eval-with-cider (expanded _params &optional cljs-p)
"Evaluate EXPANDED code block using cider.
When CLJS-P is non-nil, use a cljs connection instead of clj.
The PARAMS from Babel are not used in this function."
Writing good docstrings is hard :D
Cheers,
Daniel
next prev parent reply other threads:[~2023-03-23 11:37 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-03-09 15:40 [patch] ob-clojure: Fix results output Daniel Kraus
2023-03-10 12:35 ` Ihor Radchenko
2023-03-13 14:01 ` Daniel Kraus
2023-03-14 12:35 ` Ihor Radchenko
2023-03-14 13:38 ` Daniel Kraus
2023-03-14 14:27 ` Daniel Kraus
2023-03-15 10:20 ` Ihor Radchenko
2023-03-15 11:22 ` Daniel Kraus
2023-03-16 10:19 ` Ihor Radchenko
2023-03-19 8:07 ` Ihor Radchenko
2023-03-19 20:43 ` Daniel Kraus
2023-03-22 10:48 ` Ihor Radchenko
2023-03-23 11:31 ` Daniel Kraus [this message]
2023-03-23 11:52 ` Ihor Radchenko
2023-03-23 12:29 ` Daniel Kraus
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87mt43em3k.fsf@kraus.my \
--to=daniel@kraus.my \
--cc=emacs-orgmode@gnu.org \
--cc=yantar92@posteo.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).