Make WordPress Core

Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#57243 closed enhancement (fixed)

Remove superfluous HTML span tags from SECURITY.md

Reported by: tobiasbg's profile TobiasBg Owned by: audrasjb's profile audrasjb
Milestone: 6.2 Priority: normal
Severity: normal Version: 5.4
Component: Security Keywords: has-patch commit
Focuses: Cc:

Description

Core's SECURITY.md file is written in Markdown, and while that allows for using inline HTML code, there is no reason (at least I couldn't find one documented) to wrap all link texts in extra HTML <span> tags.

The PR https://github.com/WordPress/wordpress-develop/pull/3714 removes these extra tags to make the file more readable and maintainable.

Change History (7)

This ticket was mentioned in PR #3714 on WordPress/wordpress-develop by @TobiasBg.


3 years ago
#1

Core's SECURITY.md file is written in Markdown, and while that allows for using inline HTML code, there is no reason (at least I couldn't find one documented) to wrap all link texts in extra HTML <span> tags.

This PR removes these extra tags to make the file more readable and maintainable.

Trac ticket: https://core.trac.wordpress.org/ticket/57243

#2 @peterwilsoncc
3 years ago

  • Keywords commit added

The linked pull request looks good to me as of commit hash 88c6fcd27b.

While committing changes to the security policy recently, I noticed that npm run grunt patch had problems with the upper case file name. The following command will work but requires the GitHub CLI:

gh pr diff 3714 --repo WordPress/wordpress-develop | patch -p1

@TobiasBg commented on PR #3714:


3 years ago
#3

Yes, I also couldn't spot visual or functional differences.
In fact, there are already at least 3 Markdown links in the file that don't have these <span> tags.

My guess is that maybe a Markdown editor program added these HTML tags, when the documented was first written, or that these come from some copy/paste?

Pinging @whyisjake as the original committer of the file, in case he remembers details or has objections here.

@peterwilsoncc commented on PR #3714:


3 years ago
#4

... or that these come from some copy/paste?

My money is on this too, especially if it was originally written in a Google Doc/Word or similar. They're 🤬 for adding superfluous spans via the clipboard.

#5 @audrasjb
3 years ago

  • Owner set to audrasjb
  • Status changed from new to accepted

Self assigning for commit.

#6 @audrasjb
3 years ago

  • Resolution set to fixed
  • Status changed from accepted to closed

In 54934:

Security: Remove useless span tags from SECURITY.md.

Props TobiasBg, peterwilsoncc.
Fixes #57243.

Note: See TracTickets for help on using tickets.