Skip to content

Commit

Permalink
Update universal name documentation to include recommendation of choo…
Browse files Browse the repository at this point in the history
…sing it.

Reviewed By: yoney

Differential Revision: D69271123

fbshipit-source-id: 09ef93a7074d757959b07e46100ca9eac5726df1
  • Loading branch information
thedavekwon authored and facebook-github-bot committed Feb 6, 2025
1 parent 525eb1c commit 210aade
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion thrift/doc/features/universal-name.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ where `domain_path` is defined in [Package Declaration](/idl/index.md#package-de

A universal name is either [generated automatically](#package) based on the package name or [specified manually](#annotation) using the `@thrift.Uri` annotation.

You should ensure that universal names for your definitions are unique. For generated universal names, follow the recommendations on [naming packages](/idl/index.md#package-declaration). For `@thrift.Uri`, combine a domain name that belongs to you or your organization with a path, possibly consisting of multiple components, that uniquely identifies this definition within the domain/organization.
You should ensure that universal names for your definitions are unique. For generated universal names, follow the recommendations on [naming packages](/idl/index.md#package-declaration). For `@thrift.Uri`, combine a domain name that belongs to you or your organization with a path, possibly consisting of multiple components, that uniquely identifies this definition within the domain/organization. We recommend the last component of `@thrift.Uri` to match with the identifier.

:::caution
Universal name conflicts can be difficult to resolve, so choose these names carefully and prefer longer, more specific names to shorter, generic ones.
Expand Down

0 comments on commit 210aade

Please sign in to comment.