From 04506ded4eb0e2df646ee15989e7a453bcf4d517 Mon Sep 17 00:00:00 2001 From: karashiiro <49822414+karashiiro@users.noreply.github.com> Date: Sat, 29 May 2021 17:37:57 -0700 Subject: [PATCH] Reword createCard documentation --- create-card.js | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/create-card.js b/create-card.js index 097492e..dfa76d7 100644 --- a/create-card.js +++ b/create-card.js @@ -271,9 +271,10 @@ class CardCreator { * Creates a character card for a character. * @param {number | string} charaId The Lodestone ID of the character to generate a card for. * @param {string | Buffer | null | undefined} customImage Optional parameter providing a custom - * image to be drawn over the character card. The image should be the same resolution as - * the default image. The default image size can be retrieved with {@link CardCreator#canvasSize}. - * May be a URL, `data: `URI or a local file path or a Buffer instance. + * image to be drawn between the background of the character card and the black information boxes. + * The image should be the same resolution as the default image. The default image size can be + * retrieved with {@link CardCreator#canvasSize}. May be a URL, `data: `URI, a local file path, + * or a Buffer instance. * @example * const fs = require("fs"); *