Skip to content

DocStringExtensions.jl integration #570

Description

@haakon-e

Pre-submission checklist

Description

This is an awesome project that I've experimented with for just a little while now.

It would be cool if abbreviations from DocStringExtensions.jl would expand when previewing docs. For example, the docstring

"""
    KK2000

The type and parameters for 2-moment precipitation formation by
Khairoutdinov and Kogan (2000)

DOI:10.1175/1520-0493(2000)128<0229:ANCPPI>2.0.CO;2

# Fields
$(DocStringExtensions.FIELDS)
"""

currently display as:

Image

By comparison, the built docs would show the same as

Image

I'm not sure if this suggestion is within scope of the extension, but couldn't find any other issues raising this suggestions, so thought I'd start a discussion at least.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions