Skip to content

Commit

Permalink
docs ~ update README (mention path normalization)
Browse files Browse the repository at this point in the history
  • Loading branch information
rivy committed Dec 16, 2020
1 parent 214873f commit b9d1b55
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The object returned by the module constructor is an `OSPaths` function object, a

### Methods

All module methods return simple, platform-compatible, path strings.
All module methods return simple, platform-compatible, path strings which are normalized and have no trailing path separators.

The path strings are _not_ guaranteed to already exist on the file system. So, the user is responsible for directory construction, if/when needed.
However, since all of these are _standard_ OS directories, they should all exist without the need for user intervention.
Expand Down

0 comments on commit b9d1b55

Please sign in to comment.