Permalink
Browse files

More doc fixes. Sigh. The English she is too much for me.

  • Loading branch information...
1 parent 902299b commit a9e7ee4f0301b08b7fcf940c3ac6fee839027a70 @rocky committed Apr 7, 2013
Showing with 14 additions and 9 deletions.
  1. +4 −4 README.md
  2. +10 −5 load-relative.el
View
@@ -3,7 +3,7 @@
The rational behind module is to be able to write small Emacs
functions or modules in a larger multi-file Emacs package and
facilitate running from the source tree without having to "install"
-the code of fiddle with evil *load-path*'s . See my [NYC Lisp talk](https://github.com/rocky/emacs-load-relative/wiki/NYC-Lisp-talk) for more background on this.
+the code or fiddle with evil *load-path*'s . See my [NYC Lisp talk](https://github.com/rocky/emacs-load-relative/wiki/NYC-Lisp-talk) for more background on this.
## Contents ##
@@ -80,7 +80,7 @@ Finally, macro *provide-me* saves you the trouble of adding a symbol
after *provide*, by using the file basename (without directory or file
extension) as the name of the thing you want to provide. Using this
forces the *provide* names to be the same as the filename, but I
-consider that a good thing.
+consider that a good thing.
*provide-me* also takes an optional string which will be prepended to the provide name. This is useful if you have a multi-file package and want the files to bue prefaced with the name of the package.
@@ -98,13 +98,13 @@ inside that file is the same thing as writing:
```
Now suppose `foo.el` is part of a larger package called *bar*. Then if
-you write:
+you write:
```lisp
(provide-me "bar-")
```
-this is the same as writing:
+this is the same as writing:
```lisp
(provide 'bar-foo)
View
@@ -25,14 +25,17 @@
;;; Commentary:
;; Here we provide functions which facilitate writing multi-file Emacs
-;; packages and facilitate running from the source tree without
-;; having to "install" code.
+;; packages and facilitate running from the source tree without having
+;; to "install" code or fiddle with evil `load-path'. See
+;; https://github.com/rocky/emacs-load-relative/wiki/NYC-Lisp-talk for
+;; the the rationale behind this.
;;
-;; The functions we add ssource out of the source relative versions of
-;; `load', and `require'. We also add a `__FILE__' and a `provide-me' macro.
+;; The functions we add are relative versions of `load', and `require'
+;; and versions which take list arguments. We also add a `__FILE__'
+;; and a `provide-me' macro.
;; The latest version of this code is at:
-;; github.com/rocky/emacs-load-relative/
+;; http://github.com/rocky/emacs-load-relative/
;; `__FILE__' returns the file name that that the calling program is
;; running. If you are `eval''ing a buffer then the file name of that
@@ -79,6 +82,8 @@
;; Using this constrains the `provide' name to be the same as
;; the filename, but I consider that a good thing.
+;;; Code:
+
;;;###autoload
(defun __FILE__ (&optional symbol)
"Return the string name of file/buffer that is currently begin executed.

0 comments on commit a9e7ee4

Please sign in to comment.