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

Updated the example for addressCountry to be compliant with ISO-3166-1 alpha-2. #3364

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

miller79
Copy link

Updated the example for addressCountry to be compliant with ISO-3166-1 alpha-2.

This closes #3363

Updated the example for `addressCountry` to be compliant with ISO-3166-1 alpha-2.
@@ -4086,7 +4086,7 @@ See also the <a href="/docs/hotels.html">dedicated document on the use of schema
:PostalAddress ;
:rangeIncludes :Country,
:Text ;
rdfs:comment "The country. For example, USA. You can also provide the two-letter [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1)." .
rdfs:comment "The country. For example, US. You can also provide the two-letter [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1)." .

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"You can also" seems out of place when the US example is already ISO 3166-1 alpha-2.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is fair. The only concern with changing that wording is it fundamentally changes the definition as the way its worded currently almost feels like it can be either a country full text (USA, France, Greece) or the ISO compliant code alpha-2. If the expectation is it should always be the alpha-2 then the description needs to change to reflect that but could be breaking to some. Otherwise, I'm not sure if the ISO documentation provides any value outside of information that you may have not known in which it may be good to mention other codes such as the alpha-3 as being compliant as well.

This discussion may definitely be larger than I as previously thinking now after reading the wording.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tripped over this many times.

I suggest rephrasing it to:
"The country. It's recommended to use two-letter ISO 3166-1 alpha-2 country code. Do to historical reasons sometimes three-letter ISO 3166-1 alpha-3 country code or even full text names e.g. United States, Germany, Singapore wear used."

Copy link

This pull request is being nudged due to inactivity.

@github-actions github-actions bot added the no-pr-activity Discuss has gone quiet. Auto-tagging to encourage people to re-engage with the issue (or close it!). label Nov 22, 2023
@github-actions github-actions bot removed the no-pr-activity Discuss has gone quiet. Auto-tagging to encourage people to re-engage with the issue (or close it!). label Jan 27, 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

Successfully merging this pull request may close these issues.

Description inconsistency in addressCountry property
3 participants