Skip to content
This repository has been archived by the owner on Jan 30, 2020. It is now read-only.

Check Documentation Code Blocks #4

Closed
GeeH opened this issue Jan 20, 2016 · 0 comments · Fixed by #8
Closed

Check Documentation Code Blocks #4

GeeH opened this issue Jan 20, 2016 · 0 comments · Fixed by #8

Comments

@GeeH
Copy link
Contributor

GeeH commented Jan 20, 2016

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.

@weierophinney weierophinney self-assigned this May 4, 2016
weierophinney added a commit to weierophinney/zend-loader that referenced this issue May 5, 2016
- Converted from bookdown to mkdocs.
- Renamed files to remove `zend.locator.` prefix.
- Checked and corrected all headers. (Fixes zendframework#3)
- Checked and corrected all code blocks. (Fixes zendframework#4)
- Checked and corrected all tables. (Fixes zendframework#6)
- Checked and corrected all blockquotes. (Fixes zendframework#7)
- Reviewed and edited for content and formatting. (Fixes zendframework#5)
weierophinney added a commit that referenced this issue May 5, 2016
Close #8
Fixes #3
Fixes #4
Fixes #5
Fixes #6
Fixes #7
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants