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

Expand acronyms FQN and FQCN #33452

Merged
merged 1 commit into from
Sep 3, 2024
Merged

Expand acronyms FQN and FQCN #33452

merged 1 commit into from
Sep 3, 2024

Conversation

quaff
Copy link
Contributor

@quaff quaff commented Aug 30, 2024

We should insist on using either one to keep consistency, FQCN is more common in the Java ecosystem.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged or decided on label Aug 30, 2024
@sbrannen sbrannen added the type: documentation A documentation task label Aug 30, 2024
Copy link
Member

@sbrannen sbrannen left a 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?

@sbrannen sbrannen added status: waiting-for-feedback We need additional information before we can continue and removed status: waiting-for-triage An issue we've not yet triaged or decided on labels Aug 30, 2024
@quaff
Copy link
Contributor Author

quaff commented Aug 30, 2024

we should follow best practices for technical writing by avoiding the use of undefined acronyms.

Agreed totally.

Would you like to revise this PR accordingly?

I'd like to, do you mean replacing all FQCN with fully-qualified class name ?

@spring-projects-issues spring-projects-issues added status: feedback-provided Feedback has been provided and removed status: waiting-for-feedback We need additional information before we can continue labels Aug 30, 2024
@sbrannen
Copy link
Member

I'd like to,

👍

do you mean replacing all FQCN with fully-qualified class name ?

Yes, when it's used in text/Javadoc/comments.

When it's used in a code/syntax example, I usually go with something like <fully-qualified class name>.<method-name> instead of FQN.methodName.

@quaff quaff changed the title Use term FQCN instead of FQN Expand acronym FQN and FQCN Sep 2, 2024
@quaff
Copy link
Contributor Author

quaff commented Sep 2, 2024

I'd like to,

👍

do you mean replacing all FQCN with fully-qualified class name ?

Yes, when it's used in text/Javadoc/comments.

When it's used in a code/syntax example, I usually go with something like <fully-qualified class name>.<method-name> instead of FQN.methodName.

@sbrannen done.

@sbrannen sbrannen self-assigned this Sep 3, 2024
@sbrannen sbrannen removed the status: feedback-provided Feedback has been provided label Sep 3, 2024
@sbrannen sbrannen added this to the 6.2.0-RC1 milestone Sep 3, 2024
@sbrannen sbrannen changed the title Expand acronym FQN and FQCN Expand acronyms FQN and FQCN Sep 3, 2024
@sbrannen sbrannen merged commit 019c0b1 into spring-projects:main Sep 3, 2024
3 checks passed
sbrannen added a commit that referenced this pull request Sep 3, 2024
@sbrannen
Copy link
Member

sbrannen commented Sep 3, 2024

This has been merged into main in 019c0b1 and polished in 717b972.

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants