diff --git a/README.md b/README.md index f9ec465..4211485 100644 --- a/README.md +++ b/README.md @@ -211,7 +211,7 @@ There are a couple of different fuse types in the system: ## Administrative commands -An administrator can manually disable/reenable fuses through the following commands: +An administrator can manually disable/re-enable fuses through the following commands: ```erlang ok = fuse:circuit_disable(Name), @@ -221,7 +221,7 @@ ok = fuse:circuit_enable(Name), When you disable a circuit, you blow the fuse until you enable the circuit again. -The interaction rules for disables/enables is that they dominate every other command except the call to `remove/1`. That is, even reinstalling an already installed fuse will not reenable it. The only way is to either call `fuse:circuit_enable/1` or by first `fuse:remove/1`'ing the fuse and then executing an `install/1` command. +The interaction rules for disables/enables is that they dominate every other command except the call to `remove/1`. That is, even reinstalling an already installed fuse will not re-enable it. The only way is to either call `fuse:circuit_enable/1` or by first `fuse:remove/1`'ing the fuse and then executing an `install/1` command. ## Monitoring fuse state @@ -317,7 +317,7 @@ R01 - Heal non-installed fuse (must never be triggered) R02 - Heal installed fuse (only if blown already) Group install: -R03 - Installation of a fuse with invalid configuation +R03 - Installation of a fuse with invalid configuration R04 - Installation of a fuse with valid configuration Group Reset: @@ -345,8 +345,8 @@ R16 - Ask on an uninstalled fus Group circuitry: R17 - Disable an installed fuse R18 - Disable an uninstalled fuse -R19 - Reenable an installed fuse -R20 - Reenable an uninstalled fuse +R19 - Re-enable an installed fuse +R20 - Re-enable an uninstalled fuse R21 - Melting a disabled fus Group reset commands: diff --git a/src/fuse.erl b/src/fuse.erl index 9063af6..2cae0e1 100644 --- a/src/fuse.erl +++ b/src/fuse.erl @@ -48,7 +48,7 @@ install(Name, Options) -> %% @doc Administratively disables a circuit. %%

This function is intended to be used administratively, when you want to break the fuse %% before you do administration on the service which the fuse protects. This can be used to -%% e.g., carry out database maintenance. After maintenance, the administrator can reenable +%% e.g., carry out database maintenance. After maintenance, the administrator can re-enable %% the circuit again.

%%

Disabling a circuit dominates every other operation, except `remove/1'.

%% @end. @@ -59,7 +59,7 @@ circuit_disable(Name) -> fuse_server:circuit(Name, disable). %% @doc Administratively (re-)enables a fuse. -%%

This call is used to reenable a disabled circuit again. Always returns ok and is idempotent.

+%%

This call is used to re-enable a disabled circuit again. Always returns ok and is idempotent.

%%

Use this command at the point in time where you are done with administrative fixes and want %% to resume normal operation of the fuse.

%% @end