search

dabrahams / initsplit

John Wiegley's code to split customizations into different files, evolved!
26 stars 9 forks source link

Better documentation for initsplit-pretty-print #6

Open glasserc opened 13 years ago

glasserc commented 13 years ago

Reading the docstring for initsplit-pretty-print, I understand conceptually how pretty-printing might make changes more obvious to a VCS, but I got confused by the reference to indent-pp-sexp (which indents OR OPTIONALLY pretty-prints, and customize stanzas are usually indented).

I think an example might make this clearer. From my org mode customizations, you might say:

With initsplit-pretty-print, the customization:

'(org-capture-templates (quote (("t" "todo" entry (file+headline "~/src/org-files/incoming.org" "New") "* TODO %? %u %a"))))

Will instead be saved as:

'(org-capture-templates (quote (("t" "todo" entry (file+headline "~/src/org-files/incoming.org" "New") "* TODO %? %u %a"))))

glasserc commented 13 years ago

Right, Markdown. Thanks..

Before is roughly correct.

After:

 '(org-capture-templates
   (quote
    (("t" "todo" entry
      (file+headline "~/src/org-files/incoming.org" "New")
      "* TODO %?
%u
%a"))))