Skip to content

Improve docs for os.StatInfo #253

@megri

Description

@megri

os-lib/os/src/Model.scala

Lines 237 to 253 in 56c38a2

/**
* The result from doing an system `stat` on a particular path.
*
* Note: ctime is not same as ctime (Change Time) in `stat`,
* it is creation time maybe fall back to mtime if system not supported it.
*
* Created via `stat! filePath`.
*
* If you want more information, use `stat.full`
*/
case class StatInfo(
size: Long,
mtime: FileTime,
ctime: FileTime,
atime: FileTime,
fileType: FileType
) {

In particular the Note in the docstring is confusing. The parameter names could be better but that's an API change so I think clarifying the specific parameters in scaladoc is the way to go.

Also os.stat.full seems to be replaced with os.stat.posix.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions