Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify docs on updateTerminalSize #136

Merged
merged 1 commit into from
Nov 9, 2023
Merged

Clarify docs on updateTerminalSize #136

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion mordant/src/commonMain/kotlin/com/github/ajalt/mordant/terminal/TerminalInfo.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ data class TerminalInfo(
/**
* Query the terminal for its current size, updating [width] and [height] if successful.
*
* @return `true` if the size was updated, of `false` if it was not
* @return `true` if the terminal size was queried successfully (even if the size hasn't
* changed), or false if the size could not be determined.
*/
fun updateTerminalSize(): Boolean {
val (w, h) = TerminalDetection.detectSize() ?: return false
Expand Down