Interface

The supertype of every abbreviation. An Abbreviation interpolated into a docstring expands through its format method the first time the docstring is shown, and Julia keeps the result for the rest of the session. To write your own, subtype it and add a format method.

format(abbr, buf, doc)

Expand the Abbreviation abbr in the context of the DocStr doc and write the resulting markdown-formatted text to the IOBuffer buf. doc.data[:binding] is the documented Docs.Binding, and doc.data[:module] the module the docstring is in.

interpolation(object, expr)

The object a docstring holds in place of the interpolated object, given the expression expr that the docstring documents. Julia calls it as it defines the docstring, so a method for an Abbreviation can read code that format never sees. The fallback returns object. It runs for every object interpolated into a docstring, so add methods only for types you own.