gh-109266: Fix msvcrt.kbhit's documented return value (GH-109267)

aisk · web-flow · commit e121fca33bfb · 2023-09-12T15:44:48.000+01:00
diff --git a/Doc/library/msvcrt.rst b/Doc/library/msvcrt.rst
@@ -98,7 +98,8 @@ Console I/O
 
 .. function:: kbhit()
 
-   Return ``True`` if a keypress is waiting to be read.
+   Returns a nonzero value if a keypress is waiting to be read. Otherwise,
+   return 0.
 
 
 .. function:: getch()
diff --git a/PC/clinic/msvcrtmodule.c.h b/PC/clinic/msvcrtmodule.c.h
diff --git a/PC/msvcrtmodule.c b/PC/msvcrtmodule.c
@@ -220,12 +220,12 @@ msvcrt_get_osfhandle_impl(PyObject *module, int fd)
 /*[clinic input]
 msvcrt.kbhit -> long
 
-Return true if a keypress is waiting to be read.
+Returns a nonzero value if a keypress is waiting to be read. Otherwise, return 0.
 [clinic start generated code]*/
 
 static long
 msvcrt_kbhit_impl(PyObject *module)
-/*[clinic end generated code: output=940dfce6587c1890 input=e70d678a5c2f6acc]*/
+/*[clinic end generated code: output=940dfce6587c1890 input=d0f4cb3289ff51e2]*/
 {
     return _kbhit();
 }

Original file line number	Diff line number	Diff line change
`@@ -220,12 +220,12 @@ msvcrt_get_osfhandle_impl(PyObject *module, int fd)`
`220`	`220`	`/*[clinic input]`
`221`	`221`	`msvcrt.kbhit -> long`
`222`	`222`
`223`		`-Return true if a keypress is waiting to be read.`
	`223`	`+Returns a nonzero value if a keypress is waiting to be read. Otherwise, return 0.`
`224`	`224`	`[clinic start generated code]*/`
`225`	`225`
`226`	`226`	`static long`
`227`	`227`	`msvcrt_kbhit_impl(PyObject *module)`
`228`		`-/[clinic end generated code: output=940dfce6587c1890 input=e70d678a5c2f6acc]/`
	`228`	`+/[clinic end generated code: output=940dfce6587c1890 input=d0f4cb3289ff51e2]/`
`229`	`229`	`{`
`230`	`230`	`return _kbhit();`
`231`	`231`	`}`