Skip to content

Fix typos #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kianmeng wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix typos #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand All @@ -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

Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions src/fuse.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ install(Name, Options) ->
%% @doc Administratively disables a circuit.
%% <p>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.</p>
%% <p>Disabling a circuit dominates every other operation, except `remove/1'.</p>
%% @end.
Expand All @@ -59,7 +59,7 @@ circuit_disable(Name) ->
fuse_server:circuit(Name, disable).

%% @doc Administratively (re-)enables a fuse.
%% <p>This call is used to reenable a disabled circuit again. Always returns ok and is idempotent.</p>
%% <p>This call is used to re-enable a disabled circuit again. Always returns ok and is idempotent.</p>
%% <p>Use this command at the point in time where you are done with administrative fixes and want
%% to resume normal operation of the fuse.</p>
%% @end
Expand Down