Skip to content

@-tags used in the middle of a sentence. #1225

@panglesd

Description

@panglesd

I've seen several wrong use of tags, where the tag is used as a word in the middle of the sentence:

(**
  [f x] @returns an integer with the @param x being a float, @since 1.1, @see that.
*)

This issue can be closed by either:

  • Accepting the situation as it is, there is already a warning after all.
  • Modifying the documentation to give us a good conscience.
  • Do a very complicated thing to accept "inline tags" ( ☠️ ).

Here are some examples in the wild:

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