From 228417848995def31ec9880bb8bbf6a115b114f7 Mon Sep 17 00:00:00 2001 From: Benjamin Pollack Date: Sun, 12 Aug 2018 11:11:55 -0400 Subject: [PATCH] furnance.auth: fix documentation The docs were attempting to reference the CouchDB auth provider, but that fails, because the help vocab didn't include furnance.auth.couchdb. Since the CouchDB auth vocab has some pretty serious caveats (see its docs), remove it entirely for now. Also fixes two minor typos in the furnace.auth.couchdb docs. --- basis/furnace/auth/auth-docs.factor | 1 - basis/furnace/auth/providers/couchdb/couchdb-docs.factor | 4 ++-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/basis/furnace/auth/auth-docs.factor b/basis/furnace/auth/auth-docs.factor index 45bcb8a0ec..58317ee29a 100644 --- a/basis/furnace/auth/auth-docs.factor +++ b/basis/furnace/auth/auth-docs.factor @@ -121,7 +121,6 @@ $nl "furnace.auth.providers.null" "furnace.auth.providers.assoc" "furnace.auth.providers.db" - "furnace.auth.providers.couchdb" } ; ARTICLE: "furnace.auth.features" "Optional authentication features" diff --git a/basis/furnace/auth/providers/couchdb/couchdb-docs.factor b/basis/furnace/auth/providers/couchdb/couchdb-docs.factor index ec967f29d9..7481b7ac93 100644 --- a/basis/furnace/auth/providers/couchdb/couchdb-docs.factor +++ b/basis/furnace/auth/providers/couchdb/couchdb-docs.factor @@ -25,12 +25,12 @@ HELP: couchdb-auth-provider ARTICLE: "furnace.auth.providers.couchdb" "CouchDB Authentication Provider" "The " { $vocab-link "furnace.auth.providers.couchdb" } " vocabulary implements an authentication provider " - "which looks up authentication requests in a CouchDB. It is necessary to create a view " + "which looks up authentication requests in CouchDB. It is necessary to create a view " "associating usernames with user documents before using this vocabulary; see documentation " "for " { $link couchdb-auth-provider } "." $nl "Although this implementation guarantees that users with duplicate IDs/emails" - " cannot be created in a single CouchDB database, it provides so such guarentee if you are clustering " + " cannot be created in a single CouchDB database, it provides no such guarantee if you are clustering " "multiple DBs. In this case, you are responsible for ensuring the uniqueness of users across " "databases." $nl -- 2.34.1