Skip to content

Don't use a trailing slash on reference links #567

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

Merged
merged 1 commit into from
Jun 11, 2019
Merged

Don't use a trailing slash on reference links #567

merged 1 commit into from
Jun 11, 2019

Conversation

per1234
Copy link
Collaborator

@per1234 per1234 commented Feb 22, 2019

Following the standard established by the sample reference pages, don't put a trailing slash on links to Language Reference pages. Although either way works, it's better that all the links are consistent so that contributors don't waste time trying to figure out which style they need to use. I have left any trailing slashes as is on non-Language Reference links.

Following the standard established by the sample reference pages, don't put a trailing slash on links to Language Reference pages. Although either way works, it's better that all the links are consistent so that contributors don't waste time trying to figure out which style they need to use. I have left any trailing slashes on non-Language Reference links.
@smellai smellai merged commit bcfe72a into arduino:master Jun 11, 2019
@SeppPenner
Copy link
Contributor

@per1234 One more question: Does this apply to only links to the reference or external links as well?

When I searched for /[, I found these 6 results:
grafik

Do we need to update these links, too?

@per1234
Copy link
Collaborator Author

per1234 commented Jun 14, 2019

I like consistency because it makes it easier on the contributors. I could spend 15 seconds adding a link and then 15 minutes looking through the existing content trying to figure out why a trailing slash was used in one place but not in another, and which is correct for my link.

From reading https://stackoverflow.com/questions/5948659/when-should-i-use-a-trailing-slash-in-my-url I got the impression there may be functional reasons to use a trailing slash on URLs in some cases and not use it in others. I think I decided that we have a clear precedent set for the reference links in the reference sample page, but what's correct for the reference links is not guaranteed to be correct for random external links. Rather than try to figure that out, I decided to limit the PR to the links I was fairly confident about changing. Really, it came down to me not being an expert in web stuff and deciding "when in doubt, leave it alone". I'm receptive to opinions on whether we can safely assume that all external links can safely do without trailing slashes. I suspect it would be a very rare case where it couldn't. I also don't think we are likely to accumulate many more external links since apparently there is a policy against them. So we have a limited set of URLs that would need to be analyzed.

@SeppPenner
Copy link
Contributor

So we have a limited set of URLs that would need to be analyzed.

As far as I can see only 4 in the readme and 1 (2 occurence) towards asciitable.com :)

@per1234 per1234 deleted the remove-trailing-slash-from-reference-links branch June 25, 2019 05:15
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.

3 participants