Merge pull request #29 from ArkhamCookie/fix-examples

Fix examples
ArkhamCookie · Aug 22, 2023 · a1a9c43 · a1a9c43
2 parents faafdb8 + a4a8e60
commit a1a9c43
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 17 deletions.
diff --git a/lib/word/scrabbleScore.js b/lib/word/scrabbleScore.js
@@ -6,6 +6,12 @@ const wordnik = new Wordnik()
  * Get the Scrabble score for a word
  * @param {string} word
  * @returns {integer} - score for the word
+ *
+ * @example
+ * ```js
+ * import { scrabbleScore } from 'https://deno.land/x/wordnik/mod.js'
+ * console.log(await scrabbleScore('cookie')) // returns cookie's score (12)
+ * ```
  */
 export async function scrabbleScore(word) {
 	let response
@@ -24,11 +30,3 @@ export async function scrabbleScore(word) {
 	const data = JSON.parse(json)
 	return data.value
 }
-
-/**
- * @example
- * ```js
- * import { scrabbleScore } from 'https://deno.land/x/wordnik/mod.js'
- * console.log(await scrabbleScore('cookie')) // returns cookie's score (12)
- * ```
- */
diff --git a/lib/words/random.js b/lib/words/random.js
@@ -13,19 +13,17 @@ const wordnik = new Wordnik()
  * @param {integer} [maxDictionaryCount] - Maximum dictionary count
  * @param {integer} [minLength] - Minimum word length
  * @param {integer} [maxLength] - Maximum word length
- */
-export async function randomWord(options) {
-	const response = await fetch(wordnik.words('randomWord', options))
-	const json = JSON.stringify(await response.json())
-	const data = JSON.parse(json)
-	return data
-}
-
-/**
+ *
  * @example
  * ```js
  * import { randomWord } from 'https://deno.land/x/wordnik/mod.js'
  * const response = await randomWord()
  * console.log(response.word) // prints a random word
  * ```
  */
+export async function randomWord(options) {
+	const response = await fetch(wordnik.words('randomWord', options))
+	const json = JSON.stringify(await response.json())
+	const data = JSON.parse(json)
+	return data
+}