Update documentation.

kakao · Jan 6, 2018 · d11d38f · d11d38f
1 parent de94ddb
commit d11d38f
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/docs/Cpp_API.rst b/docs/Cpp_API.rst
@@ -35,7 +35,7 @@ default value when the metric has the default value.**
 
    -  ``dim`` (int): dimension of vectors
    -  ``metric`` (std::string): an optional parameter for choosing a
-      metric of distance. (‘L2’\|‘angular’). A default metric is
+      metric of distance. (‘L2’\|'euclidean'\|‘angular’). A default metric is
       ‘angular’.
 
 -  ``void n2::HnswIndex.AddData(const std::vector<float>& data)``: adds

diff --git a/docs/Go_API.rst b/docs/Go_API.rst
@@ -41,7 +41,7 @@ default value when the metric has the default value.**
 
    -  ``dim`` (int): dimension of vectors
    -  ``metric`` (string): an optional parameter for choosing a metric
-      of distance. (‘L2’\|‘angular’)
+      of distance. (‘L2’\|'euclidean'\|‘angular’)
 
 -  ``index.AddData(v)``: adds vector ``v``
 

diff --git a/docs/Python_API.rst b/docs/Python_API.rst
@@ -7,7 +7,7 @@ Python code example
     import random
 
     f = 40
-    t = HnswIndex(f) # HnswIndex(f, "L2 or angular") 
+    t = HnswIndex(f) # HnswIndex(f, "L2, euclidean, or angular") 
     for i in xrange(1000):
         v = [random.gauss(0, 1) for z in xrange(f)]
         t.add_data(v)
@@ -29,7 +29,7 @@ default value when the metric has the default value.**
 
    -  ``dim`` (int): dimension of vectors
    -  ``metric`` (string): an optional parameter for choosing a metric
-      of distance. (‘L2’\|‘angular’)
+      of distance. (‘L2’\|'euclidean'\|‘angular’)
 
 -  ``index.add_data(v)``: adds vector ``v``