Not self-documenting about engrave-faces HOT 7 CLOSED

I don't want to pile onto this, but quoting the README

This is very much a work in progress

It's fair that a package that isn't in a state of completion doesn't have fleshed out documentation yet. The key functions have docstrings, and if you're unsatisfied with the degree of that you are welcome to try and improve it :D

from engrave-faces.

After installing it, you use it.

from engrave-faces.

Seriously? I've given you important and useful feedback here, and you've come back with... that? Your. Doco. Does. Not. Describe. How. To. Use. It. Not. Even. A. Little. Bit. What do you do? require it? Then what? You must have seen an Emacs package before. They describe how to use themselves in fairly standard ways. Do that. Don't make users read every line of code to deduce what you mean by "use it".

from engrave-faces.

from engrave-faces.

What do you do? require it? Then what?

I don't know about you, but I usually poke around and see what the package provides. The engrave-faces library exposes a mere 20 public functions/variables. They all have non-placeholder docstrings, and I think I can reasonably expect somebody having a bit of a look at them to get a picture of how they fit together. Docstrings are not second-class citizens. After the package has matured a bit more I'll think about maybe describing some common entry points, but that's in the future.

from engrave-faces.

from engrave-faces.

Actually, it will only take me a moment to add a demo of the predominant entry point here.

(defun engrave-faces-demo--face-apply (faces content)
  (format "{%S %s}" faces content))

(engrave-faces-define-backend
 "demo" ".demo" #'engrave-faces-demo--face-apply)

;; Using our new "demo" backend

(with-current-buffer
    (with-temp-buffer
      (emacs-lisp-mode)
      (insert "(message \"hey %s\" 'you)")
      (font-lock-ensure)
      (engrave-faces-demo-buffer))
  (buffer-string))

For more comprehensive examples, there's engave-faces-{html,latex,ansi}.el.

from engrave-faces.