-
Notifications
You must be signed in to change notification settings - Fork 38.2k
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
Expand acronyms FQN
and FQCN
#33452
Expand acronyms FQN
and FQCN
#33452
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd argue that we should follow best practices for technical writing by avoiding the use of undefined acronyms.
In other words, we should never use either FQN or FQCN without first defining what is meant by the acronym used, and if we are not going to use the term or acronym multiple times in the same paragraph/section/Javadoc, we should just omit the use of the acronym altogether.
Would you like to revise this PR accordingly?
Agreed totally.
I'd like to, do you mean replacing all |
👍
Yes, when it's used in text/Javadoc/comments. When it's used in a code/syntax example, I usually go with something like |
@sbrannen done. |
We should insist on using either one to keep consistency,
FQCN
is more common in the Java ecosystem.