[DOC] Fix the description of rb_path_check

c.f. #20971
This commit is contained in:
Nobuyoshi Nakada 2025-01-12 13:53:15 +09:00
parent 723f31cf6b
commit d9d08484d2
No known key found for this signature in database
GPG Key ID: 3582D74E1FEE4465

View File

@ -287,12 +287,15 @@ VALUE rb_hash_update_by(VALUE hash1, VALUE hash2, rb_hash_update_func *func);
/* file.c */ /* file.c */
/** /**
* This function is mysterious. What it does is not immediately obvious. Also * If the PATH_SEPARATOR-separated list of directory names contains the name of
* what it does seems platform dependent. * a world-writable directory, issue a warning for it. This may do nothing on
* some platforms.
* *
* @param[in] path A local path. * @param[in] path A local path.
* @retval 0 The "check" succeeded. * @retval 0 The "check" succeeded.
* @retval otherwise The "check" failed. * @retval otherwise The "check" failed.
* @note This feature may be disabled by setting `ENABLE_PATH_CHECK`
* macro to zero at compilation time.
*/ */
int rb_path_check(const char *path); int rb_path_check(const char *path);