Skip to content

Commit

Permalink
docs: fix code for void returns
Browse files Browse the repository at this point in the history
  • Loading branch information
znotfireman committed Sep 11, 2024
1 parent f0a6c37 commit 1bfaa45
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions .lune/generate-docs/generate-docs.luau
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,10 @@ local function generateDocs()
end
code:appendLine(table.concat(args, ",\n"))
end
code:unIndent():append("):")
code:unIndent():append(")")

if util.config.returns then
code:append(" "):append(util.config.returns.type)
code:append(": "):append(util.config.returns.type)

codeDocumentation
:appendLine()
Expand Down
2 changes: 1 addition & 1 deletion src/use-effect/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
function useEffect<Scope>(
scope: Scope & Fusion.Scope,
callback: (Fusion.Use, Scope) -> ()
):
)
```

Perform side effects with state objects.
Expand Down
2 changes: 1 addition & 1 deletion src/use-interval/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ function useInterval<S>(
delay: UsedAs<number?>,
callback: (Scope<S>) -> (),
immediate: boolean?
):
)
```

Sets an interval that runs the callback function every `delay` seconds. If `delay` is `undefined`, the interval is cleared. If the delay changes, the the interval is cleared. If the delay changes, the interval is reset.
Expand Down

0 comments on commit 1bfaa45

Please sign in to comment.