Prefer site.tagline to site.description for page title #356
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@qwtel Can you add a test for a scenario that doesn't have |
|
I didn't add one specifically b/c |
ashmaroli
approved these changes
Aug 19, 2019
|
Can this be merged now? |
parkr
reviewed
Nov 10, 2019
| # Page title with site title or description appended | ||
| # rubocop:disable Metrics/CyclomaticComplexity | ||
| def title | ||
| @title ||= begin | ||
| if site_title && page_title != site_title | ||
| page_title + TITLE_SEPARATOR + site_title | ||
| elsif site_description && site_title | ||
| site_title + TITLE_SEPARATOR + site_description | ||
| site_title + TITLE_SEPARATOR + site_tagline_or_description |
There was a problem hiding this comment.
If this is the only place site_tagline_or_description is used, I’d suggest inlining the method. Feel free to use parentheses.
There was a problem hiding this comment.
I tried to do that, but it created a style offence:
Metrics/AbcSize: Assignment Branch Condition size for title is too highMetrics/PerceivedComplexity: Perceived complexity for title is too high
This comment has been minimized.
This comment has been minimized.
|
I've updated the documentation, how does it look? |
DirtyF
approved these changes
Nov 13, 2019
|
Can this be merged now? 😉 |
DirtyF
approved these changes
Nov 29, 2019
|
@jekyllbot: merge +minor |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Using
site.descriptionas part of the title for pages that don't have an explicit title --- typically the landing page of a site --- leads to very long page titles. Thesite.descriptionfield is typically used for search engine or social media previews, which are 100+ characters long, making it a bad choice for the title for pages that use the description field in this way.This PR changes the behavior of this plugin to prefer
site.taglineoversite.descriptionwhen it is available. Sites that do not define asite.taglineare not affected by this.The name
site.taglinewas chosen as it served the same role in the Hyde theme.