Add warning to specify timeout value in milliseconds, Fix #21449 (#21471)

a warning message been added to the documentation to remind users that the timeout parameter is expressed in milliseconds, not seconds. to help prevent confusion and unexpected behaviours.

1 files changed, 4 insertions, 0 deletions

diff --git a/lib/pure/osproc.nim b/lib/pure/osproc.nim
index 4cdd98c0d..915337f12 100644
--- a/lib/pure/osproc.nim
+++ b/lib/pure/osproc.nim
@@ -220,6 +220,10 @@ proc waitForExit*(p: Process, timeout: int = -1): int {.rtl,
   ##
   ## On posix, if the process has exited because of a signal, 128 + signal
   ## number will be returned.
+  ##
+  ## .. warning:: When working with `timeout` parameters, remember that the value is 
+  ##   typically expressed in milliseconds, and ensure that the correct unit of time
+  ##   is used to avoid unexpected behavior.
 
 proc peekExitCode*(p: Process): int {.rtl, extern: "nosp$1", raises: [OSError], tags: [].}
   ## Return `-1` if the process is still running. Otherwise the process' exit code.