From 436e3da7005e8591bede3615e1d0fa2b16246faa Mon Sep 17 00:00:00 2001 From: William McBrine Date: Sat, 27 May 2023 05:22:44 -0400 Subject: [PATCH] Doc fixes --- README.md | 2 +- pdcurses/inopts.c | 9 +++------ pdcurses/outopts.c | 11 ++++------- 3 files changed, 8 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index f1f07ae2..587b11dd 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ PDCurses ======== -Stable: [v3.9] +Stable: [v3.9] Current: [See git repository][git] PDCurses is a public domain curses library for [DOS], [OS/2], [Windows] diff --git a/pdcurses/inopts.c b/pdcurses/inopts.c index 9eae7ac0..14835ec7 100644 --- a/pdcurses/inopts.c +++ b/pdcurses/inopts.c @@ -101,12 +101,9 @@ inopts ### Return Value - All functions that returns an int returns OK on success and ERR on error. - - is_keypad() and is_nodelay() returns TRUE or FALSE. - - is_notimeout() is provided for compatibility with other curses - implementations, i.e. it always returns FALSE. + is_keypad() and is_nodelay() return TRUE or FALSE. is_notimeout() is + provided for compatibility with other curses implementations, and + always returns FALSE. All others return OK on success and ERR on error. ### Portability X/Open ncurses NetBSD diff --git a/pdcurses/outopts.c b/pdcurses/outopts.c index 0f6d6c17..bd012a5a 100644 --- a/pdcurses/outopts.c +++ b/pdcurses/outopts.c @@ -69,13 +69,10 @@ outopts ### Return Value - All functions that returns an int returns OK on success and ERR on error. - - is_cleared(), is_immedok(), is_leaveok() and is_scrollok() are booleans - and returns TRUE or FALSE. - - is_idlok() and is_idcok() are provided for compatibility with other curses - implementations, i.e. they always returns FALSE. + is_cleared(), is_immedok(), is_leaveok() and is_scrollok() return TRUE + or FALSE. is_idlok() and is_idcok() are provided for compatibility with + other curses implementations, and always return FALSE. All others + return OK on success and ERR on error. ### Portability X/Open ncurses NetBSD