-
Notifications
You must be signed in to change notification settings - Fork 289
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
Clarify the type of Localized URL #514
Conversation
Ping @richfab : Can I have your opinion on this change? Do you think it falls in the "Editorial changes" category? |
Hi @tdelmas, sorry for the delay. |
(sorry for the late reply too!)
I propose to define that "Localized String where the text is an URL" as "Localized URL" the type in the header, so the type is more explicit. But maybe the type "Localized URL" should be defined as "A fully qualified URL" to be even clearer? |
Tagging recent contributors to get your opinion: @mplsmitch, @testower, @cmonagle, @simonsolnes, @ezmckinn, @AntoineAugusti, @ArashMansouri, @jkurzanski. |
I agree it is confusing. And made further confusing by the fact that it is not actually the URL itself that is localized (or translated), but the URL points the a version of the content that is localized according to the language code... |
👍 transport.data.gouv.fr, a simple and useful clarification. |
👍 for Vulog |
Signed-off-by: Tom <[email protected]>
Co-authored-by: Antoine Augusti <[email protected]>
Co-authored-by: Antoine Augusti <[email protected]>
d90afde
to
18a75f2
Compare
👍 from Entur as well |
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.
One minor typo to fix. LGTM otherwise!
Thank you @tdelmas for this helpful contribution 💯
Co-authored-by: Fabien Richard-Allouard <[email protected]>
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.
LGTM!
Merging now 🚀
What is the issue and why is it an issue?
The type
Localized String
is used at a multiple places with an additional specification that text must be of the type URL. It is an issue because it makes the specification more verbose, so less readable.Please describe some potential solutions you have considered (even if they aren’t related to GBFS).
I propose to define that
Localized String
where the text is a URL asLocalized URL
. The type in the header, so the type is more explicit.But maybe the type
Localized URL
should be defined asA fully qualified URL
to be even clearer?