Doc: Document the use of \temporary (2938)

Doc: Document the use of \temporary (2938)

  Also make a brief mention of the propery stack and the
  \overrride mechanism

[Graham Percival, 2013-04-21 08:36:57]

LGTM

[janek, 2013-04-23 13:19:04]

generally LGTM.

https://codereview.appspot.com/8859044/diff/1/Documentation/extending/program...
File Documentation/extending/programming-interface.itely (right):

https://codereview.appspot.com/8859044/diff/1/Documentation/extending/program...
Documentation/extending/programming-interface.itely:413: will then pop the
previous value.
Shouldn't this be "pop the new value" or "pop the temporarily overridden value"?

[dak, 2013-04-23 13:27:45]

https://codereview.appspot.com/8859044/diff/1/Documentation/extending/program...
File Documentation/extending/programming-interface.itely (right):

https://codereview.appspot.com/8859044/diff/1/Documentation/extending/program...
Documentation/extending/programming-interface.itely:413: will then pop the
previous value.
On 2013/04/23 13:19:05, janek wrote:
> Shouldn't this be "pop the new value" or "pop the temporarily overridden
value"?

Indeed.  It is probably not overly helpful speaking of popping values since that
is ambiguous between "getting them" and "discarding them".  What is popped is
actually the stack itself.  If we want to avoid too much programmer lingo, we
probably would rather write something like

"The use of @code{\temporary} causes the (usually set) @code{pop-first} property
in the override to be cleared, so the previous value is not popped off the
property stack before pushing the new value onto it.  When a subsequent
@code{\revert} pops off the temporarily overriden value, the previous value will
reemerge."

[Trevor Daniels, 2013-04-23 18:08:20]

Respond to Janek's and David's comments

[Trevor Daniels, 2013-04-23 18:09:13]

https://codereview.appspot.com/8859044/diff/1/Documentation/extending/program...
File Documentation/extending/programming-interface.itely (right):

https://codereview.appspot.com/8859044/diff/1/Documentation/extending/program...
Documentation/extending/programming-interface.itely:413: will then pop the
previous value.
On 2013/04/23 13:27:45, dak wrote:
> On 2013/04/23 13:19:05, janek wrote:
> > Shouldn't this be "pop the new value" or "pop the temporarily overridden
> value"?
> 
> Indeed.  It is probably not overly helpful speaking of popping values since
that
> is ambiguous between "getting them" and "discarding them".  What is popped is
> actually the stack itself.  If we want to avoid too much programmer lingo, we
> probably would rather write something like
> 
> "The use of @code{\temporary} causes the (usually set) @code{pop-first}
property
> in the override to be cleared, so the previous value is not popped off the
> property stack before pushing the new value onto it.  When a subsequent
> @code{\revert} pops off the temporarily overriden value, the previous value
will
> reemerge."

Much clearer!  Thanks, both!

Done

Trevor

[Jean-Charles, 2013-04-25 09:08:30]

LGTM

Jean-Charles

[Trevor Daniels, 2013-05-07 22:49:59]

Pushed to staging as
59c80dd7c20f5ae8024a7ab0957726c21704c924
Closing ...