From d0b7df81535a0201a17adc74d6731253cd70689e Mon Sep 17 00:00:00 2001 From: Burdette Lamar Date: Fri, 25 Mar 2022 12:16:37 -0500 Subject: [PATCH] Fix formatting of What's Here for File (#5717) --- file.c | 186 ++++++++++++++++++++++++++++----------------------------- 1 file changed, 93 insertions(+), 93 deletions(-) diff --git a/file.c b/file.c index 990ae4fc64..e65e548c9a 100644 --- a/file.c +++ b/file.c @@ -6591,119 +6591,119 @@ const char ruby_null_device[] = * * === Creating * - * - ::new:: Opens the file at the given path; returns the file. - * - ::open:: Same as ::new, but when given a block will yield the file to the block, - * and close the file upon exiting the block. - * - ::link:: Creates a new name for an existing file using a hard link. - * - ::mkfifo:: Returns the FIFO file created at the given path. - * - ::symlink:: Creates a symbolic link for the given file path. + * - ::new: Opens the file at the given path; returns the file. + * - ::open: Same as ::new, but when given a block will yield the file to the block, + * and close the file upon exiting the block. + * - ::link: Creates a new name for an existing file using a hard link. + * - ::mkfifo: Returns the FIFO file created at the given path. + * - ::symlink: Creates a symbolic link for the given file path. * * === Querying * * _Paths_ * - * - ::absolute_path:: Returns the absolute file path for the given path. - * - ::absolute_path?:: Returns whether the given path is the absolute file path. - * - ::basename:: Returns the last component of the given file path. - * - ::dirname:: Returns all but the last component of the given file path. - * - ::expand_path:: Returns the absolute file path for the given path, - * expanding ~ for a home directory. - * - ::extname:: Returns the file extension for the given file path. - * - ::fnmatch? (aliased as ::fnmatch):: Returns whether the given file path - * matches the given pattern. - * - ::join:: Joins path components into a single path string. - * - ::path:: Returns the string representation of the given path. - * - ::readlink:: Returns the path to the file at the given symbolic link. - * - ::realdirpath:: Returns the real path for the given file path, - * where the last component need not exist. - * - ::realpath:: Returns the real path for the given file path, - * where all components must exist. - * - ::split:: Returns an array of two strings: the directory name and basename - * of the file at the given path. - * - #path (aliased as #to_path):: Returns the string representation of the given path. + * - ::absolute_path: Returns the absolute file path for the given path. + * - ::absolute_path?: Returns whether the given path is the absolute file path. + * - ::basename: Returns the last component of the given file path. + * - ::dirname: Returns all but the last component of the given file path. + * - ::expand_path: Returns the absolute file path for the given path, + * expanding ~ for a home directory. + * - ::extname: Returns the file extension for the given file path. + * - ::fnmatch? (aliased as ::fnmatch): Returns whether the given file path + * matches the given pattern. + * - ::join: Joins path components into a single path string. + * - ::path: Returns the string representation of the given path. + * - ::readlink: Returns the path to the file at the given symbolic link. + * - ::realdirpath: Returns the real path for the given file path, + * where the last component need not exist. + * - ::realpath: Returns the real path for the given file path, + * where all components must exist. + * - ::split: Returns an array of two strings: the directory name and basename + * of the file at the given path. + * - #path (aliased as #to_path): Returns the string representation of the given path. * * _Times_ * - * - ::atime:: Returns a \Time for the most recent access to the given file. - * - ::birthtime:: Returns a \Time for the creation of the given file. - * - ::ctime:: Returns a \Time for the metadata change of the given file. - * - ::mtime:: Returns a \Time for the most recent data modification to - * the content of the given file. - * - #atime:: Returns a \Time for the most recent access to +self+. - * - #birthtime:: Returns a \Time the creation for +self+. - * - #ctime:: Returns a \Time for the metadata change of +self+. - * - #mtime:: Returns a \Time for the most recent data modification - * to the content of +self+. + * - ::atime: Returns a \Time for the most recent access to the given file. + * - ::birthtime: Returns a \Time for the creation of the given file. + * - ::ctime: Returns a \Time for the metadata change of the given file. + * - ::mtime: Returns a \Time for the most recent data modification to + * the content of the given file. + * - #atime: Returns a \Time for the most recent access to +self+. + * - #birthtime: Returns a \Time the creation for +self+. + * - #ctime: Returns a \Time for the metadata change of +self+. + * - #mtime: Returns a \Time for the most recent data modification + * to the content of +self+. * * _Types_ * - * - ::blockdev?:: Returns whether the file at the given path is a block device. - * - ::chardev?:: Returns whether the file at the given path is a character device. - * - ::directory?:: Returns whether the file at the given path is a diretory. - * - ::executable?:: Returns whether the file at the given path is executable - * by the effective user and group of the current process. - * - ::executable_real?:: Returns whether the file at the given path is executable - * by the real user and group of the current process. - * - ::exist?:: Returns whether the file at the given path exists. - * - ::file?:: Returns whether the file at the given path is a regular file. - * - ::ftype:: Returns a string giving the type of the file at the given path. - * - ::grpowned?:: Returns whether the effective group of the current process - * owns the file at the given path. - * - ::identical?:: Returns whether the files at two given paths are identical. - * - ::lstat:: Returns the File::Stat object for the last symbolic link - * in the given path. - * - ::owned?:: Returns whether the effective user of the current process - * owns the file at the given path. - * - ::pipe?:: Returns whether the file at the given path is a pipe. - * - ::readable?:: Returns whether the file at the given path is readable - * by the effective user and group of the current process. - * - ::readable_real?:: Returns whether the file at the given path is readable - * by the real user and group of the current process. - * - ::setgid?:: Returns whether the setgid bit is set for the file at the given path. - * - ::setuid?:: Returns whether the setuid bit is set for the file at the given path. - * - ::socket?:: Returns whether the file at the given path is a socket. - * - ::stat:: Returns the File::Stat object for the file at the given path. - * - ::sticky?:: Returns whether the file at the given path has its sticky bit set. - * - ::symlink?:: Returns whether the file at the given path is a symbolic link. - * - ::umask:: Returns the umask value for the current process. - * - ::world_readable?:: Returns whether the file at the given path is readable - * by others. - * - ::world_writable?:: Returns whether the file at the given path is writable - * by others. - * - ::writable?:: Returns whether the file at the given path is writable - * by the effective user and group of the current process. - * - ::writable_real?:: Returns whether the file at the given path is writable - * by the real user and group of the current process. - * - #lstat:: Returns the File::Stat object for the last symbolic link - * in the path for +self+. + * - ::blockdev?: Returns whether the file at the given path is a block device. + * - ::chardev?: Returns whether the file at the given path is a character device. + * - ::directory?: Returns whether the file at the given path is a diretory. + * - ::executable?: Returns whether the file at the given path is executable + * by the effective user and group of the current process. + * - ::executable_real?: Returns whether the file at the given path is executable + * by the real user and group of the current process. + * - ::exist?: Returns whether the file at the given path exists. + * - ::file?: Returns whether the file at the given path is a regular file. + * - ::ftype: Returns a string giving the type of the file at the given path. + * - ::grpowned?: Returns whether the effective group of the current process + * owns the file at the given path. + * - ::identical?: Returns whether the files at two given paths are identical. + * - ::lstat: Returns the File::Stat object for the last symbolic link + * in the given path. + * - ::owned?: Returns whether the effective user of the current process + * owns the file at the given path. + * - ::pipe?: Returns whether the file at the given path is a pipe. + * - ::readable?: Returns whether the file at the given path is readable + * by the effective user and group of the current process. + * - ::readable_real?: Returns whether the file at the given path is readable + * by the real user and group of the current process. + * - ::setgid?: Returns whether the setgid bit is set for the file at the given path. + * - ::setuid?: Returns whether the setuid bit is set for the file at the given path. + * - ::socket?: Returns whether the file at the given path is a socket. + * - ::stat: Returns the File::Stat object for the file at the given path. + * - ::sticky?: Returns whether the file at the given path has its sticky bit set. + * - ::symlink?: Returns whether the file at the given path is a symbolic link. + * - ::umask: Returns the umask value for the current process. + * - ::world_readable?: Returns whether the file at the given path is readable + * by others. + * - ::world_writable?: Returns whether the file at the given path is writable + * by others. + * - ::writable?: Returns whether the file at the given path is writable + * by the effective user and group of the current process. + * - ::writable_real?: Returns whether the file at the given path is writable + * by the real user and group of the current process. + * - #lstat: Returns the File::Stat object for the last symbolic link + * in the path for +self+. * * _Contents_ * - * - ::empty? (aliased as ::zero?):: Returns whether the file at the given path - * exists and is empty. - * - ::size:: Returns the size (bytes) of the file at the given path. - * - ::size?:: Returns +nil+ if there is no file at the given path, - * or if that file is empty; otherwise returns the file size (bytes). - * - #size:: Returns the size (bytes) of +self+. + * - ::empty? (aliased as ::zero?): Returns whether the file at the given path + * exists and is empty. + * - ::size: Returns the size (bytes) of the file at the given path. + * - ::size?: Returns +nil+ if there is no file at the given path, + * or if that file is empty; otherwise returns the file size (bytes). + * - #size: Returns the size (bytes) of +self+. * * === Settings * - * - ::chmod:: Changes permissions of the file at the given path. - * - ::chown:: Change ownership of the file at the given path. - * - ::lchmod:: Changes permissions of the last symbolic link in the given path. - * - ::lchown:: Change ownership of the last symbolic in the given path. - * - ::lutime:: For each given file path, sets the access time and modification time - * of the last symbolic link in the path. - * - ::rename:: Moves the file at one given path to another given path. - * - ::utime:: Sets the access time and modification time of each file - * at the given paths. - * - #flock:: Locks or unlocks +self+. + * - ::chmod: Changes permissions of the file at the given path. + * - ::chown: Change ownership of the file at the given path. + * - ::lchmod: Changes permissions of the last symbolic link in the given path. + * - ::lchown: Change ownership of the last symbolic in the given path. + * - ::lutime: For each given file path, sets the access time and modification time + * of the last symbolic link in the path. + * - ::rename: Moves the file at one given path to another given path. + * - ::utime: Sets the access time and modification time of each file + * at the given paths. + * - #flock: Locks or unlocks +self+. * * === Other * - * - ::truncate:: Truncates the file at the given file path to the given size. - * - ::unlink (aliased as ::delete):: Deletes the file for each given file path. - * - #truncate:: Truncates +self+ to the given size. + * - ::truncate: Truncates the file at the given file path to the given size. + * - ::unlink (aliased as ::delete): Deletes the file for each given file path. + * - #truncate: Truncates +self+ to the given size. * */