Prevent user error when incorrectly formatted footnotes are added to HTML attachments #287
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
AshGDS
changed the title
AshGDS
force-pushed
the
acronym_error_fix
branch
2 times, most recently
from
2bd1f40
to
539b6c5
Compare
brucebolt
reviewed
Aug 30, 2023
There was a problem hiding this comment.
The code change looks good 👍.
I've made a suggestion for the CHANGELOG, to clarify that this only affects incorrectly formatted footnotes.
I'd also suggest adding an example of the incorrect formatting we saw in this document into the commit message, so there's a permanent record of the problem being solved here.
CHANGELOG.md
Outdated
| @@ -1,3 +1,7 @@ | |||
| ## Unreleased | |||
|
|
|||
| * Prevent user error when footnotes are added to HTML attachments ([#287](https://github.com/alphagov/govspeak/pull/287)) | |||
There was a problem hiding this comment.
Suggested change
| * Prevent user error when footnotes are added to HTML attachments ([#287](https://github.com/alphagov/govspeak/pull/287)) | |
| * Prevent user error when incorrectly formatted footnotes are added to HTML attachments ([#287](https://github.com/alphagov/govspeak/pull/287)) |
There was a problem hiding this comment.
Thanks @brucebolt - I removed the reference to incorrect formatting as I was still getting issues when I removed the example we found. But now I've realised the footnote above the one we identified was broken as well, as it contained | which I think was triggering the table formatting.
There was a problem hiding this comment.
I'll reintroduce the wording you suggested
AshGDS
changed the title
AshGDS
force-pushed
the
acronym_error_fix
branch
from
539b6c5
to
b7648c5
Compare
…HTML attachments When footnotes are used in HTML attachments, this function would cause an unhelpful user error to be displayed. This will allow the attachment to save. Example of incorrectly formatted footnotes: [^22]: CDC. Centre for Disease Control and Prevention. Invasive Mold Infections in Immunocompromised People [updated 06/06/2019]. Available from: Invasive Mold Infections in Immunocompromised People | Mold | CDC 23. David J. Pevalin, Aaron Reeves, Emma Baker, Rebecca Bentley, The impact of persistent poor housing conditions on mental health: A longitudinal population-based study, Preventive Medicine, Volume 105, 2017, Pages 304-310, https://doi.org/10.1016/j.ypmed.2017.09.020 22 contains the character | which triggers table formatting. 23 is not correctly formatted as a footnote. Co-authored-by: Bruce Bolt <bruce.bolt@digital.cabinet-office.gov.uk>
AshGDS
force-pushed
the
acronym_error_fix
branch
from
b7648c5
to
b9199e8
Compare
brucebolt
approved these changes
Aug 30, 2023
Merged
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.
When incorrectly formatted footnotes are used on HTML attachments in Whitehall, the function would cause an unhelpful user error to be displayed.
html.gsub!seemed to crash with footnotes in an attachment, ashtmlwas nil: https://govuk.sentry.io/issues/4415164546/?project=202259&query=is%3Aunresolved&referrer=issue-stream&stream_index=0This will allow the attachment to save.
This repo is owned by the publishing platform team. Please let us know in #govuk-publishing-platform when you raise any PRs.