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

Feedback - Incorrect Code Formatting in "Introduction to securely developing plugins". #3098

Open
nareshbheda opened this issue Feb 17, 2025 · 1 comment
Labels
Awaiting Triage Issues awaiting triage. See Training Team handbook for how to triage issues.

Comments

@nareshbheda
Copy link

Type of feedback

// content

Description

The tutorial "Introduction to Securely Developing Plugins" contains a block of PHP code that is not properly formatted using the
wporg-code-block. This makes it harder to read and copy for learners.

Issue

  • The current code block is missing proper WordPress code formatting, such as the wporg-code-block wrapper.
  • The buttons for "Copy" and "Expand Code" are not present.
  • The syntax highlighting is inconsistent.

Step-by-step reproduction instructions

  1. Visit the tutorial: Introduction to securely developing plugins
  2. Locate the PHP code block.
  3. Notice the missing structure and improper formatting.

Screen recording

Introduction.to.securely.developing.plugins._.Learn.WordPress.webm

Suggested Fix

To improve readability and usability, wrap the PHP code inside a wporg-code-block with Copy and Expand Code buttons. This will ensure correct syntax highlighting and easy copying for learners.

I have a screenshot for better understanding.

Image

Thank you.

@nareshbheda nareshbheda added the Awaiting Triage Issues awaiting triage. See Training Team handbook for how to triage issues. label Feb 17, 2025
@benazeer-ben
Copy link

Feedback Validation Checklist:

  • If this is reporting an issue, can you confirm/reproduce the issue? Yes
  • What should happen next to apply the feedback?: Wrap the PHP code inside a wporg-code-block with Copy and Expand Code buttons

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Awaiting Triage Issues awaiting triage. See Training Team handbook for how to triage issues.
Projects
None yet
Development

No branches or pull requests

2 participants