search

com-lihaoyi / os-lib

OS-Lib is a simple, flexible, high-performance Scala interface to common OS filesystem and subprocess APIs
Other
672 stars 63 forks source link

Improve docs for os.StatInfo #253

Open megri opened 6 months ago

megri commented 6 months ago

https://github.com/com-lihaoyi/os-lib/blob/56c38a23798f5c900a2583277b70604b4574999b/os/src/Model.scala#L237-L253

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.