Skip to content

should nbdev convert parameter names to links in markdown? #221

@pete88b

Description

@pete88b

#218 updated show_doc to not convert names in backticks to links - if the name is used as a parameter of the element passed to show_doc.

This means that you can backtick a module or function name in the doc string of a function and

  • it will be formatted as code (not converted to a link)
  • if the name is used as a parameter of the function.

I think it could be worth extending this behavior to the markdown following a show_doc call - as described here.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions