Skip to content

Docstrings need to embed parameters in backticks #72

Description

@asinghvi17

Otherwise, underscores get parsed as markdown, leading to:

Screenshot 2024-04-14 at 9 23 19 PM

Activity

  1. bvdmitri commented on Mar 11, 2025

    @bvdmitri

    Bump, it is indeed an issue, e.g.

    Image

    from the following markdown

    # **get_server_info**
    > get_server_info(req::HTTP.Request;) -> ServerInfo
  2. github-actions commented on Sep 22, 2026

    @github-actions

    This issue has been automatically marked as stale because it has had no activity in the last 60 days. It will be closed in 7 days if no further activity occurs. Comment or remove the stale label to keep it open.

  3. tanmaykm commented on Oct 2, 2026

    @tanmaykm
    Member
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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