Create api-conventions.asciidoc #25217
Conversation
Added a few specific numeric date math examples in place of the text ones.
| `now+1h+1m`:: The current time plus one hour plus one minute, with ms resolution. | ||
| `now+1h/d`:: The current time plus one hour, rounded down to the nearest day. | ||
| `2015-01-01||+1M/d`:: `2015-01-01` plus one month, rounded down to the nearest day. | ||
| [options="header"] |
There was a problem hiding this comment.
Please keep the definition list format instead of a table. Tables don't render terribly well in Docbook.
There was a problem hiding this comment.
I changed that as it matched the index date math table above. Do you want me to update that one as well while I am at it?
| [options="header"] | ||
| |====== | ||
| | Expression | Resolves to | ||
| | `now+1h` | `2001-01-01 13:00:00` |
There was a problem hiding this comment.
I'm OK with adding the resolved date, but I think we should keep the text explanation as that explains the logic that is applied, rather than having to make the user second guess it
There was a problem hiding this comment.
Yeah, I was thinking that as well. I'll add it back :D
|
@markwalkom can you update this PR and then ping Clint again for another review? |
|
Sure thing, sorry for letting this one lapse! |
|
@dakrone I don't think I can have a horizontal labeled list with multiple columns, at least not based on what I can find in various guides/docs for asciidoc. So not sure I can update things as per Clint's comments. |
|
@markwalkom I think you can still use the |
|
Yeah but that is for a "table" with only two columns.
If I want to have the example + output + description, it won't work :(
…On 8 September 2017 at 02:11, Lee Hinman ***@***.***> wrote:
@markwalkom <https://github.com/markwalkom> I think you can still use the -
thing :: description format that the list was previously in?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#25217 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/ADCYTjYenooHSVuJkIvPT_hUt3snXlq9ks5sgBWggaJpZM4N5mQv>
.
|
|
@clintongormley could you help @markwalkom updating the PR so that it can be merged please? |
|
@markwalkom I don't think you need separate columns, just do it in the text: |
|
Thanks @clintongormley, how does that look now? |
|
@markwalkom @clintongormley just built the affected docs page, this looks good, should I merge this in on the 5.6+ branches? |
|
please do @cbuescher |
Added a few specific numeric date math examples in place of the text ones.