Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in

Issue 157133: Doc: improve doc on markup command writing (Closed)

Can't Edit
Can't Publish+Mail
Start Review
9 years, 7 months ago by nicolas.sceaux
8 years, 2 months ago
Ian Hulin, dak


Doc: improve doc on markup command writing

Patch Set 1 #

Total comments: 42

Patch Set 2 : Take into accout remarks from review #

Unified diffs Side-by-side diffs Delta from patch set Stats (+290 lines, -151 lines) Patch
M Documentation/extending/programming-interface.itely View 1 2 chunks +257 lines, -151 lines 0 comments Download
scm/markup.scm View 1 chunk +33 lines, -0 lines 0 comments Download


Total messages: 7
Hi, This patch improves (as I hope) the documentation on markup command definition, by using ...
9 years, 7 months ago (2009-11-22 15:37:58 UTC) #1
Graham Percival
On Sun, Nov 22, 2009 at 3:37 PM, <nicolas.sceaux@gmail.com> wrote: > As I'm not (obviously) ...
9 years, 7 months ago (2009-11-22 16:10:03 UTC) #2
Ian Hulin
Nicolas, These are mainly stylistic changes. Please double-check to ensure I haven't changed the meaning ...
9 years, 7 months ago (2009-11-22 16:59:49 UTC) #3
Thank you Ian for the careful review. Nicolas http://codereview.appspot.com/157133/diff/1/2 File Documentation/extending/programming-interface.itely (right): http://codereview.appspot.com/157133/diff/1/2#newcode1045 Documentation/extending/programming-interface.itely:1045: The ...
9 years, 7 months ago (2009-11-22 17:30:42 UTC) #4
Le 22 nov. 2009 à 17:10, Graham Percival a écrit : > On Sun, Nov ...
9 years, 7 months ago (2009-11-22 17:50:22 UTC) #5
On 11/22/09 10:50 AM, "Nicolas Sceaux" <nicolas.sceaux@gmail.com> wrote: > Le 22 nov. 2009 à 17:10, ...
9 years, 7 months ago (2009-11-23 02:24:02 UTC) #6
9 years, 7 months ago (2009-11-24 16:51:54 UTC) #7
It would make sense to apply <URL:http://codereview.appspot.com/160048> first
and make this patch work on top of that.

There may be cases where a separate property-bind like this is useful in called
routines, and the markup commands from the mentioned patch might make use of it
for implementing #:properties.  However, a separate property-bind function can't
do the job of entering the properties and their defaults into the command

For this reason, it is probably not a good idea to encourage users to use a
macro like this in markups defined with define-markup-command.  They would need
to be rewritten in order to get the properties mentioned in the command

Since the above-mentioned patch does not provide user-level documentation, it
would make sense to adapt your patch here for documenting the functionality
provided by the above-mentioned patch of mine.
Sign in to reply to this message.

Powered by Google App Engine
RSS Feeds Recent Issues | This issue
This is Rietveld f62528b