Add API for idempotent page description editing #1765
Merged
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
Like setTitle, this function should really be idempotent so developers don't add multiple conflicting meta descriptions to the page. Unlike setTitle, the function currently fails its idempotency test.
`setDescription` and `setDescriptionI` present a similar API to `setTitle` and `setTitleI`, but unlike those functions the description functions are not idempotent - so calling them multiple times inserts multiple `<meta/>` tags in HTML `<head/>`. This adds explicitly idempotent versions of those functions which are handled in a similar way to the title, so that calling them multiple times has the effect of taking the final value specified. Because the non-idempotent behaviour of setDescription is not obvious, this also adds warnings for that behaviour to make it clear what the effect of multiple calls will be. Unfortunately, setDescriptionIdemp can't be made a drop-in replacement because developers may have defined their own layouts which need to take pageDescription into account.
ivanbakel
changed the title
snoyberg
approved these changes
Apr 20, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
setDescriptionandsetDescriptionIare slightly surprising in that they are not idempotent, and multiple calls to these functions will insert multiple<meta>tags in the page head. Since these functions present likesetTitleandsetTitleI, I would have expected them to have a similar idempotent behaviour.This adds idempotent versions of these functions, which behave like
setTitleandsetTitleIin that they store information in the page data and can be called any number of times, taking the final value supplied.Because they use the page data, these functions can't be drop-in replacements for the existing functions - users with custom layouts will have to manually edit them to use the new idempotent functions, since they have to explicitly include the new
pageDescriptionfield in their layouts (while the old functions write to the page head.)Points for review
descriptionas a meta tag to something stored in the page data sensible? Should the same approach be taken for other meta tags? Should arbitrary meta tags appear in the page data?Before submitting your PR, check that you've:
@sincedeclarations to the Haddocks for new, public APIsAfter submitting your PR: