Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
panglesd opened this issue Oct 29, 2024 · 0 comments
Open

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

panglesd opened this issue Oct 29, 2024 · 0 comments

Comments

@panglesd
Copy link
Collaborator

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:

@panglesd panglesd changed the title @-tags used in the middle of the sentence. @-tags used in the middle of a sentence. Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant