documentation changes word2vec_similarity (use of itemize)

bnosac · Feb 19, 2024 · c955af5 · c955af5
1 parent cafe13f
commit c955af5
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,7 @@
+## CHANGES IN word2vec VERSION 0.4.1
+
+- documentation changes in word2vec_similarity regarding the use of braces
+
 ## CHANGES IN word2vec VERSION 0.4.0
 
 - Drop C++11 specification in Makevars

diff --git a/R/word2vec.R b/R/word2vec.R
@@ -523,8 +523,8 @@ predict.word2vec_trained <- function(object, newdata, type = c("nearest", "embed
 #' @title Similarity between word vectors as used in word2vec
 #' @description The similarity between word vectors is defined 
 #' \itemize{
-#'  \item{for type 'dot': }{as the square root of the average inner product of the vector elements (sqrt(sum(x . y) / ncol(x))) capped to zero}
-#'  \item{for type 'cosine': }{as the the cosine similarity, namely sum(x . y) / (sum(x^2)*sum(y^2)) }
+#'  \item{for type 'dot': as the square root of the average inner product of the vector elements (sqrt(sum(x . y) / ncol(x))) capped to zero}
+#'  \item{for type 'cosine': as the the cosine similarity, namely sum(x . y) / (sum(x^2)*sum(y^2)) }
 #' }
 #' @param x a matrix with embeddings where the rownames of the matrix provide the label of the term
 #' @param y a matrix with embeddings where the rownames of the matrix provide the label of the term

diff --git a/man/word2vec_similarity.Rd b/man/word2vec_similarity.Rd