com php-langspec: Rephrase to be more normative.: FORMATTING.md

Commit: 0dbcce95894d4e632829940852da86363e37adc8 Author: Florian Anderiasch <fa@php.net> Wed, 30 Jul 2014 23:58:41 +0200 Parents: 7fa7f220a42f8a9aa5d3da1eaf280076f937d81a Branches: master Link: http://git.php.net/?p=php-langspec.git;a=commitdiff;h=0dbcce95894d4e632829940852da86363e37adc8 Log: Rephrase to be more normative. Changed paths: M FORMATTING.md Diff: diff --git a/FORMATTING.md b/FORMATTING.md index 68beb41..d758168 100644 --- a/FORMATTING.md +++ b/FORMATTING.md @@ -1,16 +1,20 @@ # Formatting rules -1. The format of this document is [Markdown](http://daringfireball.net/projects/markdown/) +1. The format of the PHP Language Specification is + [Markdown](http://daringfireball.net/projects/markdown/). 2. Everything in the actual specification document must be ASCII only. 3. The only allowed extensions to original Markdown are tables and code blocks (indicated by three backticks). 4. Style * Use spaces to indent, not tabs.. - * Use of prefixed ## is preferred for headers over underlined === + * For headings, use prefixed hash symbols # Example, not underlining it + with ===. * Use of *inline* links [example](http://example.org) is preferred over - *reference* links [example][xmpl] unless used multiple times. This is to - allow for easier splitting and reorganization. - * Do not embed external images not hosted on php.net. + *reference* links [example][xmpl] unless used multiple times in a + paragraph or section. This is to allow for easier splitting and + reorganization of the document. + * Do not embed external images not hosted on [php.net](http://php.net) + infrastructure. * Try to stick to 80 chars wide, if possible. This is not as strict as - in code, but still easier to read most of the times. This does only apply - to text, not to code examples or tables. + in coding standard rules, but still easier to read most of the times. + This does only apply to text, not to code examples or tables.