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.

Sign up for GitHub

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

Jump to bottom

Improve the docs for File.Stat #4017

Merged
merged 1 commit into from Nov 30, 2015
Merged

Improve the docs for File.Stat #4017

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 5 additions & 4 deletions lib/elixir/lib/file/stat.ex
View file
Open in desktop
Expand Up @@ -2,7 +2,7 @@ require Record

defmodule File.Stat do
@moduledoc """
A struct responsible to hold file information.
A struct that holds file information.

In Erlang, this struct is represented by a `:file_info` record.
Therefore this module also provides functions for converting
Expand Down Expand Up @@ -41,10 +41,11 @@ defmodule File.Stat do
* `inode` - gives the inode number. On non-Unix file systems, this field
will be zero.

* `uid` - indicates the owner of the file.
* `uid` - indicates the owner of the file. Will be zero for non-Unix file
systems.

* `gid` - gives the group that the owner of the file belongs to. Will be
zero for non-Unix file systems.
* `gid` - indicates the group that owns the file. Will be zero for
non-Unix file systems.

The time type returned in `atime`, `mtime`, and `ctime` is dependent on the
time type set in options. `{:time, type}` where type can be `:local`,
Expand Down