-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
doc_markdown should ignore things which just contain acronyms #1136
Comments
I have a crate where this warning is extremely annoying: https://github.com/gnzlbg/bitintr The documentation is full of acronyms like x86_64, ARMv7, AMD, ... this warning trips up in extremely many files. IMO the correct fix should be to only suggest putting something into `` when it is actually a type. |
Or a function, or a variant, or a mod, or… A this must be from any crate the project depends on. |
@Manishearth That will still end up linting 15/39 of the current whitelist ( I could give this one a crack but I think first we have to figure out a decent heuristic. The current rule is not great, specially that it ignores things that end in 's' as if they're plural (what about The idea of checking if the word is an identifier present in the crate (or module) or its dependencies sounds better. Is it feasible? |
Perhaps PascalCase words should have their own separate lint. It feels sufficiently more pedantic and less consequential than other parts of |
Instead of needing to manually whitelist, we should ignore things like
DirectX
andOpenGL
. For something to be camel case, it should have at least two camelcase words in it, each which have at least one lowercase letter.The text was updated successfully, but these errors were encountered: