Skip to content

Commit

Permalink
Add documentation to Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
haji-ali committed Feb 26, 2023
1 parent e482d5a commit 0e6027d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -627,6 +627,12 @@ that takes effect, but `el-patch` retains a record of both patches,
meaning they can be inspected and validated individually. See
[#29](https://github.com/radian-software/el-patch/issues/29).

You may also define patches of functions as `:override` advices
instead of overriding the original definition. This is done by setting
`el-patch-use-advice` to a non-nil value (either dynamically around a
patch or globally). The patched function must have the same name and
number of arguments as the original function.

## Usage with byte-compiled init-file

`el-patch` does not need to be loaded at runtime just to define
Expand Down
2 changes: 1 addition & 1 deletion el-patch.el
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ This function lives halfway between `copy-sequence' and
tree))

(defun el-patch--advice-name (name variant-name)
"Return advice name for a given NAME, TYPE and VARIANT-NAME."
"Return advice name for a given NAME and VARIANT-NAME."
(intern
(format "%S@%s@el-patch--advice"
name
Expand Down

0 comments on commit 0e6027d

Please sign in to comment.