Function: denote--link-get-description

denote--link-get-description is a function alias for denote-get-link-description, defined in denote.el.

This function is obsolete since 4.0.0; use denote-get-link-description instead.

Signature

(denote--link-get-description FILE &optional FILE-TYPE)

Documentation

Return a link description for FILE.

If denote-link-description-format is a function, call it with FILE and FILE-TYPE as argument. It should return a string, representing the link description.

If the user option denote-link-description-format is a string, parse it to substitute any format specifiers therein with their respective values (see the documentation of that user option). If the region is active, use it as the description.

For backward compatibility, support the scenario where the function assigned to denote-link-description-format accepts a single FILE argument. In that case, the function takes care to find the TYPE on its own to return the appropriate description.

Aliases

denote--link-get-description (obsolete since 4.0.0)