diff options
| author | Nobuyoshi Nakada <nobu@ruby-lang.org> | 2023-11-02 10:31:13 +0900 |
|---|---|---|
| committer | Nobuyoshi Nakada <nobu@ruby-lang.org> | 2023-11-02 10:31:13 +0900 |
| commit | ee90a7f981cc69c076f7443bd523596c9aef7bcd (patch) | |
| tree | bae2b0dce2063276ebff1a9053b5bd05136a0da4 /include | |
| parent | 45eee0cd9444634fb9fe9a7a8db5d394658e6c60 (diff) | |
| download | ruby-ee90a7f981cc69c076f7443bd523596c9aef7bcd.tar.gz | |
[DOC] Update the document for `FilePathStringValue`
Diffstat (limited to 'include')
| -rw-r--r-- | include/ruby/ruby.h | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/include/ruby/ruby.h b/include/ruby/ruby.h index 0c1e1c2a6e..91e24bcebd 100644 --- a/include/ruby/ruby.h +++ b/include/ruby/ruby.h @@ -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)) |