emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Ihor Radchenko <yantar92@posteo.net>
To: "Sławomir Grochowski" <slawomir.grochowski@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: [FR] org-colview.el, add annotation for functions summary-types
Date: Thu, 15 Aug 2024 16:48:35 +0000	[thread overview]
Message-ID: <878qwx3f6k.fsf@localhost> (raw)
In-Reply-To: <87ttfllupj.fsf@gmail.com>

Sławomir Grochowski <slawomir.grochowski@gmail.com> writes:

>> See `help--symbol-completion-table-affixation'.
>
> It's a private function and I need only a part of it. 
> Should I extract that part and create a new function? Like this below?
>
> (defun first-line-docstring (fun)
>   (let* ((doc (condition-case nil (documentation fun) (error nil)))
>          (doc (and doc (substring doc 0 (string-search "\n" doc)))))
>     (if doc
>         (format " -- %s" doc)
>       "")))

This would make sense, yes.  Probably for org-macs.el

Why not applying faces?

>> I'd also prefer using a proper completing-read API instead of
>> `completion-extra-properties' - by using `completion-extra-properties',
>> we disallow users from utilizing this variable.
>
> OK. Based on this example
> https://emacs.stackexchange.com/questions/74547/completing-read-search-also-in-annotations
> I came up with this snippet below:
>
> (completing-read
>  "Summary: "
>  (lambda (s pred flag)
>    (pcase flag
>      ('t (all-completions s
>                             (mapcar #'car org-columns-summary-types-default)
>                             pred))
>      ('metadata (list 'metadata
>                       (cons 'annotation-function
>                             (lambda (c)
>                               (first-line-docstring
>                                (cdr (assoc c org-columns-summary-types-default))))))))))

Looks reasonable.
Although, I'd prefer to avoid lambda here and simply make it into a
proper function. Just like `org-tags-completion-function'.

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>


  reply	other threads:[~2024-08-15 16:48 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-08 17:53 [FR] org-colview.el, add annotation for functions summary-types Sławomir Grochowski
2024-08-10 13:03 ` Ihor Radchenko
2024-08-15 14:35   ` Sławomir Grochowski
2024-08-15 16:48     ` Ihor Radchenko [this message]
2024-08-15 17:29       ` Sławomir Grochowski
2024-08-15 17:41         ` Ihor Radchenko
2024-08-16 11:13           ` Sławomir Grochowski
2024-08-18  9:56             ` Ihor Radchenko

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=878qwx3f6k.fsf@localhost \
    --to=yantar92@posteo.net \
    --cc=emacs-orgmode@gnu.org \
    --cc=slawomir.grochowski@gmail.com \
    /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).