Update docs

This commit is contained in:
DBotThePony 2023-01-31 00:27:04 +07:00
parent 5ee05f3a6b
commit c5c2a3a3cb
Signed by: DBot
GPG Key ID: DCC23B5715498507

View File

@ -36,7 +36,7 @@ interface IMatteryEnergyStorage : IEnergyStorage {
* Therefore, if you want/need to obey [energyFlow], use [extractEnergyChecked] * Therefore, if you want/need to obey [energyFlow], use [extractEnergyChecked]
* *
* General contracts: * General contracts:
* * Negative values are not allowed, failing to comply with this contract will result in undefined behavior (worst case) or exception (best case) * * Negative values are not allowed, failing to comply with this contract will result in undefined behavior in worst case or nothing in best case
* * Returned value CAN NOT be bigger than requested [howMuch], implementations failing to obey this contract will cause undefined behavior in upstream code. * * Returned value CAN NOT be bigger than requested [howMuch], implementations failing to obey this contract will cause undefined behavior in upstream code.
* Upstream code SHOULD NOT check for this contract. * Upstream code SHOULD NOT check for this contract.
* *
@ -68,7 +68,7 @@ interface IMatteryEnergyStorage : IEnergyStorage {
* Therefore, if you want/need to obey [energyFlow], use [receiveEnergyChecked] * Therefore, if you want/need to obey [energyFlow], use [receiveEnergyChecked]
* *
* General contracts: * General contracts:
* * Negative values are not allowed, failing to comply with this contract will result in undefined behavior (worst case) or exception (best case) * * Negative values are not allowed, failing to comply with this contract will result in undefined behavior in worst case or nothing in best case
* * Returned value CAN NOT be bigger than requested [howMuch], implementations failing to obey this contract will cause undefined behavior in upstream code. * * Returned value CAN NOT be bigger than requested [howMuch], implementations failing to obey this contract will cause undefined behavior in upstream code.
* Upstream code SHOULD NOT check for this contract. * Upstream code SHOULD NOT check for this contract.
* *