]> gitweb.factorcode.org Git - factor.git/commitdiff
furnance.auth: fix documentation 2038/head
authorBenjamin Pollack <benjamin@bitquabit.com>
Sun, 12 Aug 2018 15:11:55 +0000 (11:11 -0400)
committerBenjamin Pollack <benjamin@bitquabit.com>
Sun, 12 Aug 2018 15:12:22 +0000 (11:12 -0400)
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
basis/furnace/auth/providers/couchdb/couchdb-docs.factor

index 45bcb8a0ec27a8bd316cd48526583b633f803c7f..58317ee29a2643d8dbce22430c7968ecf18d3eba 100644 (file)
@@ -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"
index ec967f29d91ca7e4564bdb1d2e7a1ff081b25731..7481b7ac937e83be9af4ca372327ac9cebcada44 100644 (file)
@@ -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 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