Skip to content

docs: lint the PHP samples in the user guide - #10722

Open
paulbalandan wants to merge 1 commit into
codeigniter4:developfrom
paulbalandan:docs-lint-samples
Open

paulbalandan wants to merge 1 commit into
codeigniter4:developfrom
paulbalandan:docs-lint-samples

Conversation

@paulbalandan

Copy link
Copy Markdown
Member

Description
First follow up on the docs migration.

The script extracts the sample codes in the docs, parses them to check if valid PHP, then runs PHP-CS-Fixer over them in a temp directory. Adding <!-- lint-ignore --> over the code block lets the scan skip them.

Checklist:

  • Securely signed commits
  • Component(s) with PHPDoc blocks, only if necessary or adds value (without duplication)
  • Unit testing, with >80% coverage
  • User guide updated
  • Conforms to style guide

@carson-codeigniter4 carson-codeigniter4 Bot added the github_actions Pull requests that update Github_actions code label Nov 4, 2026

@michalsn michalsn left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Comment thread admin/lint-docs-samples.php Resolved

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

github_actions Pull requests that update Github_actions code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants