config.md: format changes #724
Conversation
config.md
Outdated
| * **`prestart`** (array, OPTIONAL) is an array of [pre-start hooks](#prestart). | ||
| Entries in the array contain the following properties: | ||
| * **`path`** (string, REQUIRED) with similar semantics to [IEEE Std 1003.1-2001 `execv`'s *path*][ieee-1003.1-2001-xsh-exec]. | ||
| This specification extends the IEEE standard in that **`path`** MUST be absolute. |
There was a problem hiding this comment.
I think you want an additional two or four spaces of indent for this line so it is clearly part of the path entry in the source.
Other than that (and a confif → config typo in the commit message), 79afbeb looks good to me.
|
Not sure I understand the end goal of all these indentation changes -- does this make the output look nicer or something? |
|
On Wed, May 10, 2017 at 01:15:29PM -0700, Tianon Gravi wrote:
Not sure I understand the end goal of all these indentation changes
-- does this make the output look nicer or something?
Pandoc (which we're still using to render single-page HTML and PDF
forms) requires four-space (or tab) indents for nested lists and such.
See #495 for more details.
|
|
Can you rebase and fix the indention |
zhouhao3
force-pushed
the
fix-configmd
branch
3 times, most recently
from
7ed40cb to
6e6790e
Compare
config.md
Outdated
| * **`prestart`** (array of objects, OPTIONAL) is an array of [pre-start hooks](#prestart). | ||
| Entries in the array contain the following properties: | ||
| * **`path`** (string, REQUIRED) with similar semantics to [IEEE Std 1003.1-2001 `execv`'s *path*][ieee-1003.1-2001-xsh-exec]. | ||
| This specification extends the IEEE standard in that **`path`** MUST be absolute. |
There was a problem hiding this comment.
Doesn't this line need two more spaces to line up with the path bullet contents properly?
config.md
Outdated
| * **`args`** (array of strings, OPTIONAL) with the same semantics as [IEEE Std 1003.1-2001 `execv`'s *argv*][ieee-1003.1-2001-xsh-exec]. | ||
| * **`env`** (array of strings, OPTIONAL) with the same semantics as [IEEE Std 1003.1-2001's `environ`][ieee-1003.1-2001-xbd-c8.1]. | ||
| * **`timeout`** (int, OPTIONAL) is the number of seconds before aborting the hook. | ||
| If set, `timeout` MUST be greater than zero. |
There was a problem hiding this comment.
Same here -- I think this needs two more spaces, doesn't it?
config.md
Outdated
| * **`timeout`** (int, OPTIONAL) is the number of seconds before aborting the hook. | ||
| If set, `timeout` MUST be greater than zero. | ||
| * **`poststart`** (array of objects, OPTIONAL) is an array of [post-start hooks](#poststart). | ||
| Entries in the array have the same schema as pre-start entries. |
There was a problem hiding this comment.
Oh hmm, either this has two too many or the others I've commented on actually need four more spaces rather than simply two (which seems the more likely, given that pandoc is apparently picky about it being precisely "four spaces or a tab").
Signed-off-by: zhouhao <zhouhao@cn.fujitsu.com>
|
LGTM |
|
LGTM |
Signed-off-by: zhouhao zhouhao@cn.fujitsu.com