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

HTML tag in wp-config.php MySQL Socket example code #979

Closed
com2 opened this issue Jul 19, 2023 · 2 comments
Closed

HTML tag in wp-config.php MySQL Socket example code #979

com2 opened this issue Jul 19, 2023 · 2 comments
Assignees
Labels
APIs Issues for Common APIs Handbook [Status] Done Issue is completed

Comments

@com2
Copy link

com2 commented Jul 19, 2023

Issue Description

wp-config.php >> Set database host code examples with erroneous HTML tags

URL of the Page with the Issue

https://developer.wordpress.org/apis/wp-config-php/#set-database-host

Section of Page with the issue

MySQL Sockets or Pipes configuration code examples

Why is this a problem?

Ignorant users not aware of the proper socket path syntax might blindly copy and paste including the HTML tag and it would annoyingly cause the site to fail. I.a.w. the <strong> HTML tags was meant to make the documentation text bold and it was not meant to be part of the example text.

Suggested Fix

Remove the <strong> tag or alternatively make the documentation text bold in a correct manner, that it remains invisible in the code example.

@com2 com2 added the [Status] To do Issue marked as Todo label Jul 19, 2023
@stevenlinx stevenlinx added the APIs Issues for Common APIs Handbook label Jul 31, 2023
@github-actions
Copy link

Heads up @zzap - the "apis" label was applied to this issue.

@stevenlinx stevenlinx self-assigned this Jul 31, 2023
@github-actions github-actions bot added [Status] In progress Issue is in progress and removed [Status] To do Issue marked as Todo labels Jul 31, 2023
@stevenlinx
Copy link
Member

Thank you for filing.

I've removed the html tag from the code examples.

@github-actions github-actions bot added [Status] Done Issue is completed and removed [Status] In progress Issue is in progress labels Nov 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIs Issues for Common APIs Handbook [Status] Done Issue is completed
Projects
None yet
Development

No branches or pull requests

2 participants