chore(api): apply locale passed to RariApi::link + make optional #287
Conversation
| pub fn link( | ||
| link: &str, | ||
| locale: Locale, | ||
| locale: Option<Locale>, |
There was a problem hiding this comment.
Yagni: We don't seem to pass None anywhere.
There was a problem hiding this comment.
That was a hint from Florian, for consistency of the API.
There was a problem hiding this comment.
I think it's a necessary inclusion: otherwise we have no way of keeping the locale in the url untouched
| ) -> Result<String, DocError> { | ||
| let mut out = String::new(); | ||
| let (url, locale) = if let Some(locale) = locale { | ||
| (link.strip_prefix("/en-US/docs").unwrap_or(link), locale) |
There was a problem hiding this comment.
Shouldn't we strip this prefix in api_list_alpha.rs instead? We probably shouldn't pass in a link with a locale here.
There was a problem hiding this comment.
There are numerous calls for RariApi::link in the code base. I have tried to change all of them to not pass in the locale in the url, but this would be a deep change that also muddles the water between url and slug terms. This version solves the issue, I also run a complete output diff before and after the change, making sure that nothing unexpected has been changed.
There was a problem hiding this comment.
We probably shouldn't pass in a link with a locale here.
I disagree, I don't think we should concern ourselves with locale stripping in every single macro implementation if we can have a generic function which does it for us - which this change adds
| pub fn link( | ||
| link: &str, | ||
| locale: Locale, | ||
| locale: Option<Locale>, |
There was a problem hiding this comment.
I think it's a necessary inclusion: otherwise we have no way of keeping the locale in the url untouched
| ) -> Result<String, DocError> { | ||
| let mut out = String::new(); | ||
| let (url, locale) = if let Some(locale) = locale { | ||
| (link.strip_prefix("/en-US/docs").unwrap_or(link), locale) |
There was a problem hiding this comment.
We probably shouldn't pass in a link with a locale here.
I disagree, I don't think we should concern ourselves with locale stripping in every single macro implementation if we can have a generic function which does it for us - which this change adds
Description
The
{{APIListAlpha}}macro was handling locale incorrectly (always returning en-US links, regardless of the presence of a translated page).Motivation
Repairing a leftover regression after moving to rari, made explicit in this Issue.
Additional details
While fixing the logic, it was decided to make the function shape more in line with the rest of the internal API, by passing in an optional locale to
RariApi::link. Concequently, all callers of the function had to be changed as well.Related issues and pull requests
fixes #286