From 62c06a26987bc4817d97580e12227ac8d66ad537 Mon Sep 17 00:00:00 2001 From: Eryn Lynn Date: Tue, 10 Sep 2019 16:00:43 -0400 Subject: [PATCH] Update documentation --- .vuepress/config.js | 3 ++- lib/README.md | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.vuepress/config.js b/.vuepress/config.js index f82a638..19e5f1e 100644 --- a/.vuepress/config.js +++ b/.vuepress/config.js @@ -36,7 +36,8 @@ module.exports = { placeholder: 'Press S to search...' }, nav: [ - { text: 'API Reference', link: '/lib/' } + { text: 'API Reference', link: '/lib/' }, + { text: 'GitHub', link: 'https://github.com/evaera/roblox-lua-promise' } ], sidebarDepth: 3, diff --git a/lib/README.md b/lib/README.md index 774a366..a619c64 100644 --- a/lib/README.md +++ b/lib/README.md @@ -21,6 +21,7 @@ docs: - name: Status tags: [ 'read only', 'static', 'enums' ] type: PromiseStatus + desc: A table containing all members of the `PromiseStatus` enum, e.g., `Promise.Status.Resolved`. functions: @@ -94,7 +95,7 @@ docs: - type: boolean desc: "`true` if the given `object` is a Promise." - name: spawn - desc: Spawns a thread with predictable timing. The callback will be called on the next `RunService.Stepped` event. + desc: Spawns a thread with predictable timing. The callback will be called on the next `RunService.Heartbeat` event. static: true params: - name: callback