diff options
| -rw-r--r-- | doc/ranger.1 | 7 | ||||
| -rw-r--r-- | doc/ranger.pod | 7 |
2 files changed, 10 insertions, 4 deletions
diff --git a/doc/ranger.1 b/doc/ranger.1 index 1bbcd349..dcfc3b95 100644 --- a/doc/ranger.1 +++ b/doc/ranger.1 @@ -357,8 +357,11 @@ Also try: \& pydoc ranger.api .Ve .PP -The \fIexamples\fR directory contains several sample plugins, including a well -documented hello-world plugin using hooks in a compatibility-friendly way. +Note that you should \s-1NOT\s0 simply overwrite a function unless you know what +you're doing. Instead, save the existing function and call it from your new +one. This way, multiple plugins can use the same hook. There are several +sample plugins in the \fIexamples/\fR directory, including a hello-world plugin +that describes this procedure. .SH "KEY BINDINGS" .IX Header "KEY BINDINGS" Key bindings are defined in the file \fIranger/config/rc.conf\fR. Check this diff --git a/doc/ranger.pod b/doc/ranger.pod index 219d2f0b..bab92412 100644 --- a/doc/ranger.pod +++ b/doc/ranger.pod @@ -257,8 +257,11 @@ Also try: pydoc ranger.api -The F<examples> directory contains several sample plugins, including a well -documented hello-world plugin using hooks in a compatibility-friendly way. +Note that you should NOT simply overwrite a function unless you know what +you're doing. Instead, save the existing function and call it from your new +one. This way, multiple plugins can use the same hook. There are several +sample plugins in the F<examples/> directory, including a hello-world plugin +that describes this procedure. |