[DOC] Update the document for FilePathStringValue

This commit is contained in:
Nobuyoshi Nakada 2023-11-02 10:31:13 +09:00
parent 45eee0cd94
commit ee90a7f981
No known key found for this signature in database
GPG Key ID: 3582D74E1FEE4465

View File

@ -97,8 +97,10 @@ VALUE rb_get_path(VALUE obj);
VALUE rb_get_path_no_checksafe(VALUE);
/**
* @deprecated This macro is an alias of #FilePathValue now. The part that did
* "String" was deleted. It remains here because of no harm.
* This macro actually does the same thing as #FilePathValue now. The "String"
* part indicates that this is for when a string is treated like a pathname,
* rather than the actual pathname on the file systems. For examples:
* `Dir.fnmatch?`, `File.join`, `File.basename`, etc.
*/
#define FilePathStringValue(v) ((v) = rb_get_path(v))