Files
modeling-app/docs/kcl/assertLessThanOrEq.md
Nick Cameron df278c7e6a Various hover improvements (#5617)
* Show more info on hover for variables

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Move hover impls to lsp module

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Make hover work on names inside calls, fix doc line breaking, trim docs in tool tips

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Test the new hovers; fix signature syntax

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Hover tips for kwargs

Signed-off-by: Nick Cameron <nrc@ncameron.org>

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-03-04 09:53:31 +00:00

26 KiB

title, excerpt, layout
title excerpt layout
assertLessThanOrEq Check that a numerical value is less than or equal to another at runtime, otherwise raise an error. manual

Check that a numerical value is less than or equal to another at runtime, otherwise raise an error.

assertLessThanOrEq(
  left: number,
  right: number,
  message: string,
): ()

Arguments

Name Type Description Required
left number Yes
right number Yes
message string Yes

Returns

()

Examples

assertLessThanOrEq(1, 2, "1 is less than 2")
assertLessThanOrEq(1, 1, "1 is equal to 1")

Rendered example of assertLessThanOrEq 0