Docstrings are changed in 9a22101
<https://github.com/leo-editor/leo-editor/commit/9a22101d01237512111ac461c6a628fac2c5ba08>
.
1. `set-reference-file`
"""Shows file open dialog allowing user to select a
*reference* Leo document to which this outline will
be bound.
In essence this command will insert a node (if there
is not already there) with the special headline and
in body path to selected reference Leo file.
This command should be used along with two other
commands: `update-ref-file` and `read-ref-file`.
They will operate on the *public* part of the outline,
which consists of all nodes above this special node.
`update-ref-file` will save the *public* part of
this outline to reference Leo file.
`read-ref-file` will replace completely *public*
part of this outline with the content of reference
Leo file. Keep in mind that it will show no mercy to
any changes you have made to the *public* part of
this outline."""
2. `update-ref-file`
'''Saves *public* part of this outline (which consists
of all nodes above the special separator node to the
reference Leo file. This special separator node is
created by executing command `set-reference-file`.
Below this special node is *private* area where
one can freely make changes that should not be
published (yet) to reference Leo file.'''
3. `read-ref-file`
'''This command will replace completely *public*
part of this outline with the content of reference
Leo file. Keep in mind that it will show no mercy to
any changes made to the *public* part of this outline.
The *public* part of outline consists of all nodes above
the special *separator* node. This *separator* node is
created by executing `set-reference-file` command.'''
Vitalije
On Tuesday, September 12, 2017 at 4:40:51 PM UTC+2, Edward K. Ream wrote:
>
> I got Leo out the door yesterday a bit early, because I thought it was
> important to test the code now. Still to do:
>
> 1. The read/set/update-ref-file commands should have better docstrings and
> a full write-up in the release notes, based on Vitalije's initial
> documentation
> <https://groups.google.com/forum/#!topic/leo-editor/yAtfcG6AL70> of these
> commands.
>
> 2. I have several "to be documented" items in my mailbox, which I'll also
> fold into the release notes.
>
> Edward
>
--
You received this message because you are subscribed to the Google Groups
"leo-editor" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/leo-editor.
For more options, visit https://groups.google.com/d/optout.
