From a4ee9a2e847be317d8e1290545291eebb4fccd95 Mon Sep 17 00:00:00 2001 From: Filip Tibell Date: Wed, 8 Mar 2023 13:05:19 +0100 Subject: [PATCH] Fix some incorrect docs --- CHANGELOG.md | 1 + docs/luneTypes.d.luau | 5 ++++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7e9ecc6..ac63e1c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,6 +23,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed - Fixed the CLI being a bit too picky about file names when trying to run files in `lune` or `.lune` directories +- Fixed documentation misses from large changes made in version `0.5.0` ## `0.5.4` - March 7th, 2023 diff --git a/docs/luneTypes.d.luau b/docs/luneTypes.d.luau index 5a927fc..6cc84b3 100644 --- a/docs/luneTypes.d.luau +++ b/docs/luneTypes.d.luau @@ -676,7 +676,10 @@ declare task: { --[=[ @within Task - Waits for the given duration, with a minimum wait time of 10 milliseconds. + Waits for *at least* the given amount of time. + + The minimum wait time possible when using `task.wait` is limited by the underlying OS sleep implementation. + For most systems this means `task.wait` is accurate down to about 5 milliseconds or less. @param duration The amount of time to wait @return The exact amount of time waited