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

Fix link scope #1931

Merged
merged 1 commit into from
Jul 17, 2024
Merged

Fix link scope #1931

merged 1 commit into from
Jul 17, 2024

Conversation

timhoffm
Copy link
Contributor

@timhoffm timhoffm commented Jul 16, 2024

Typically, one does not include articles in the link.

Typically, one does not include articles into the link.
Copy link
Collaborator

@drammock drammock left a comment

Choose a reason for hiding this comment

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

Is there guidance about this somewhere? I'm inclined to trust your intuition, but FWIW my instinct here is opposite: I tend to want make links on phrasal consituents (which in this case would mean the full noun phrase, including the article). But that might just be me / my training. Happy to follow suit if you say "at least matplotlib and scipy do it consistently this way" or some similar impression of loose consensus.

Copy link

Coverage report

This PR does not seem to contain any modification to coverable code.

@timhoffm
Copy link
Contributor Author

timhoffm commented Jul 17, 2024

My proposal was based in intuition. But thinking about it, I believe it's because "Sphix Themes Gallery" is a proper noun. Note that "Sphinx Book Theme" above also does not contain the article. I would leave out articles if the rest of the link is just the proper noun. By that the proper noun is more clearly visible.

Examples for proper-name only:

Whereas include the article if it is a phrase:

I believe the issue is specific to proper nouns that are phrase like, i.e. where it contains a noun itself. In that case language flow tends to add an article. Compare:

  • See Furo for more ideas. [no article - OK]
  • See Sphinx Theme Gallery for more ideas. [no article - slightly bumpy]
  • See the Sphinx Theme Gallery for more ideas. [with article - better flow]

While the language flow profits from the article here, I still believe the link should only cover the proper noun to make it stand out more.

It's hard finding authoritative reference. Some loosely related links:

@trallard
Copy link
Collaborator

I have no strong opinion here (regarding including articles or not) and I have to admit I have never given this a lot of thought.

So long we always use descriptive text (and not phrasing like: here, link, click here) this should be fine from an a11y and SEO point of view which I do have strong opinions on. So whatever y'all decide is good, but perhaps it's worth checking we use such an approach throughout the docs for consistency.

@timhoffm
Copy link
Contributor Author

Just a case in point from the footer:

image

But overall, this was thought as a quick fix for something I stumbled over, and I've already lost far too many words on this 😄.
Please take or leave as you see fit.

@drammock
Copy link
Collaborator

I'm convinced

@drammock drammock merged commit 29a0d37 into pydata:main Jul 17, 2024
29 checks passed
@timhoffm timhoffm deleted the patch-2 branch July 17, 2024 11:28
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