zendframework/zend-json

Check Documentation Code Blocks

GeeH opened this issue · 2 comments

GeeH commented

Check code blocks are correct

TLDR; Check in all files that codeblocks are correct, in PSR-2 format and have PHP syntax highlighting applied.

Code blocks should be in the following format...

```php
 'ZEND-FRAMEWORK');

// No required options
$rendererOptions = array();
$renderer = Barcode::factory(
    'code39', 'image', $barcodeOptions, $rendererOptions
);

```

Note the three backticks then php in the opening fence, and the closing fence is just three backticks. It's common for the opening backticks to have no code type, or something like source.

Code should also have been automatically formatted into PSR-2 format, but sometimes these slip through the net.

Only one wrong type: XML not PHP - see: https://github.com/zendframework/zend-json/blob/master/doc/book/zend.json.xml2json.md

All others are fine!

A code block with Json is also wrong,