Skip to content

Auto link to realized generics referenced in documentation #861

@sawatts

Description

@sawatts

Problem Description

pdoc will generate links to symbols enclosed in back-ticks, where it recognizes those symbols; `Foo` would be rendered as a hyperlink to the documentation for the Foo symbol.

This does no seem to occur with references to realized generics; `Foo[Bar,Wibble]` does not generate a hyperlink, even if Foo, Bar, and/or Wibble are symbols in context.

Proposal

When parsing back-tick references, support syntax for generic realizations and insert hyperlinks for recognized symbols.

Alternatives

Could write `Foo` `[` `Bar` `,` `Wibble` `]` - but this is very messy and I think this still generates breaks between each monospaced element: Foo [ Bar , Wibble ].

Additional context

When reviewing generated documentation we can spot items which are missing from public API docs as they are not hyperlinked.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions