Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Change Log

All notable changes to this project will be documented in this file.
See [Conventional Commits](Https://conventionalcommits.org) for commit guidelines.

<!-- changelog -->

## [v0.1.0](https://github.com/diffo-dev/outstanding/compare/v0.1.0...v0.1.0) (2025-03-11)

### Features:
* initial version

## [v0.2.0](https://github.com/diffo-dev/outstanding/compare/v0.1.0...v0.2.0) (2025-05-12)

### Features:
* duration
* added outstanding? to protocol (use Outstanding.outstanding? rather than Outstand.outstanding?)
* livebook

## [v0.2.1](https://github.com/diffo-dev/outstanding/compare/v0.2.0...v0.2.1) (2025-05-17)

### Features
* enhanced List implementation
* fixed Duration and related expected functions not to use to_timeout
File renamed without changes.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ by adding `outstanding` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:outstanding, "~> 0.2.0"}
{:outstanding, "~> 0.3.0"}
]
end
```
Expand Down Expand Up @@ -141,15 +141,13 @@ Expected functions of arity 2 are also supported. These have the form of a tuple

You can supply your own functions where needed.

## Infix Shortcuts
### Exceeds and Difference Operators

`use Outstand` expression provides infix shortcuts for outstanding
Also it provides infix shortcuts for these utilities:
For convenient use in expressions we've implemented operators.

| Equivalent Function | infix shortcut | returns | memory aid |
|--------------------------------------------|-------------------------|------------------------|--------------------------|
| Outstanding.outstanding(expected, actual) | expected --- actual | nil or Outstanding.t() | expected less actual |
| Outstanding.outstanding?(expected, actual) | expected >>> actual | boolean | expected exceeds actual? |
The 'exceeds' operator tells us whether our expectations exceed our actual. ```expected >>> actual``` is equivalent to ```Outstanding.outstanding?(expected, actual)```

The 'difference' operator tells us what expectations remain unmet. ```expected --- actual``` is equivalent to ```Outstanding.outstanding(expected, actual)```

Example of infix shortcuts usage:

Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.2.0
0.2.1
Loading