Re: [FR] org-colview.el, add annotation for functions summary-types

[Ihor Radchenko]

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

> When the user wants to add a new column (or edit an existing one), he
> executes the command `org-columns-new'. Then he can enter or select a few
> 'column attributes' (see in manual 
> https://orgmode.org/org.html#Column-attributes-1).
> One of the attributes is "SUMMARY-TYPE". This attribute can be selected
> from the list of very enigmatic symbols such as "+", "$", "X"
> which do not convey any information to the user. So, I have prepared a
> solution that will address this issue.
>
> For each symbol, the 'docstring' of the function assigned to that symbol
> will be displayed. For example: 
> "+ -- Compute the sum of VALUES."  
> "$ -- Compute the sum of VALUES, with two decimals."
>
> What do you think about this solution? 

I like the idea.

> * org-colview.el (org-columns--first-line-docstring): add function that
> retrieves the first line of function's docstring.
> I have not found a function that would do such a simple thing, it seems
> to me that such functionality is often used but there is no special
> function for it? I couldn't find one, so I wrote my own. But it is a
> general-purpose function and should not be located in org-colview.

See `help--symbol-completion-table-affixation'.

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.

-- 
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>