Skip to content

Commit

Permalink
(#43) Document the changes
Browse files Browse the repository at this point in the history
  • Loading branch information
ForNeVeR committed Jun 20, 2024
1 parent f00023e commit 2f1f3a3
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

## [Unreleased] (1.3.0)
### Added
- `IPath::IsPrefixOf` to check path prefixes.
- `IPath::StartsWith` to check if the current path starts with a specified path.
- [#38: Introduce `AbsolutePath::CurrentWorkingDirectory`](https://github.com/ForNeVeR/TruePath/issues/38).

### Changed
Expand Down
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,20 +76,16 @@ Aside from the strict types, the following features are supported for the paths:
- `IPath::FileName` returns the last component of the path;
- `IPath::Parent` returns the parent path item (`null` for the root path or top-level relative path);
- `IPath<T>` supports operators to join it with `LocalPath` or a `string` (note that in both cases appending an absolute path to path of another kind will take over: the last absolute path in chain will win and destroy all the previous ones; this is the standard behavior of path-combining methods — use `AbsolutePath` in combination with `RelativePath` if you want to avoid this behavior);
- `IPath::IsPrefixOf` to check path prefixes;
- `IPath::StartsWith` to check if the current path starts with a specified path;
- `LocalPath::IsAbsolute` to check the path kind (since it supports both kinds);
- `LocalPath::IsPrefixOf` to check path prefixes;
- `LocalPath::RelativeTo` to get a relative part between two paths, if possible;
- extension methods on `IPath`:
- `GetExtensionWithDot` and `GetExtensionWithoutDot` to get the file extension with or without the leading dot (note that `GetExtensionWithDot` will behave differently for paths ending with dots and paths without dot at all);
- `GetFileNameWithoutExtension` to get the file name without the extension (and without the trailing dot, if any)

(Note how `GetFileNameWithoutExtension()` works nicely together with `GetExtensionWithDot()` to reconstruct the resulting path from their concatenation, however weird the initial name was — no extension, trailing dot, no base name.)

### Unreleased

- `IPath::IsPrefixOf` to check path prefixes.
- `IPath::StartsWith` to check if the current path starts with a specified path.

Documentation
-------------
- [Contributor Guide][docs.contributing]
Expand Down

0 comments on commit 2f1f3a3

Please sign in to comment.