Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docstrings for filesize and stat #56244

Merged
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions base/stat.jl
Original file line number Diff line number Diff line change
Expand Up @@ -201,9 +201,11 @@

"""
stat(file)
stat(joinpath...)
stat(path_elements...)

Return a structure whose fields contain information about the file.

Check warning on line 206 in base/stat.jl

View workflow job for this annotation

GitHub Actions / Check whitespace

Whitespace check

trailing whitespace
LilithHafner marked this conversation as resolved.
Show resolved Hide resolved
If multiple arguments are given, they are joined by `joinpath`.

Return a structure whose fields contain information about the file.
The fields of the structure are:

| Name | Type | Description |
Expand Down Expand Up @@ -308,9 +310,11 @@
end

"""
filesize(path...)
filesize(file)
filesize(path_elements...)

Equivalent to `stat(file).size`.
If multiple arguments are given, they are joined by `joinpath`.
"""
filesize(st::StatStruct) = st.size

Expand Down
Loading