Skip to content

Commit

Permalink
Fix screen turnOn/turnOff return value docs (#3698)
Browse files Browse the repository at this point in the history
These component method calls actually both return two booleans, but only
the first one was documented.
  • Loading branch information
Hawk777 authored Apr 7, 2024
1 parent 871e3c8 commit 1097acd
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/main/scala/li/cil/oc/common/component/TextBuffer.scala
Original file line number Diff line number Diff line change
Expand Up @@ -178,14 +178,14 @@ class TextBuffer(val host: EnvironmentHost) extends AbstractManagedEnvironment w
@Callback(direct = true, doc = """function():boolean -- Returns whether the screen is currently on.""")
def isOn(computer: Context, args: Arguments): Array[AnyRef] = result(isDisplaying)

@Callback(doc = """function():boolean -- Turns the screen on. Returns true if it was off.""")
@Callback(doc = """function():boolean -- Turns the screen on. Returns whether the state changed, and whether it is now on.""")
def turnOn(computer: Context, args: Arguments): Array[AnyRef] = {
val oldPowerState = isDisplaying
setPowerState(value = true)
result(isDisplaying != oldPowerState, isDisplaying)
}

@Callback(doc = """function():boolean -- Turns off the screen. Returns true if it was on.""")
@Callback(doc = """function():boolean -- Turns off the screen. Returns whether the state changed, and whether it is now on.""")
def turnOff(computer: Context, args: Arguments): Array[AnyRef] = {
val oldPowerState = isDisplaying
setPowerState(value = false)
Expand Down

0 comments on commit 1097acd

Please sign in to comment.