Skip to content

Commit

Permalink
Merge changelog into package readme
Browse files Browse the repository at this point in the history
  • Loading branch information
thinker227 committed Jan 15, 2024
1 parent 14ba56e commit 51a50bf
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 42 deletions.
41 changes: 0 additions & 41 deletions CHANGELOG.md

This file was deleted.

1 change: 0 additions & 1 deletion src/Rascal/Rascal.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
<!-- Include additional files -->
<ItemGroup>
<None Include="./package-readme.md" Pack="true" PackagePath="/" />
<None Include="../../CHANGELOG.md" Pack="true" PackagePath="/"/>
</ItemGroup>

<!-- Polyfills for netstandard2.0 -->
Expand Down
44 changes: 44 additions & 0 deletions src/Rascal/package-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,47 @@ Rascal is a simple yet powerful [result type](https://www.youtube.com/watch?v=sr
Rascal is first and foremost an aggregate of the result types I personally find myself implementing in a majority of my own projects, and a competetor other result libraries second. As such, this library implements some things I think other result implementations are lacking, while omitting some features other libraries do implement.

The full library documentation is available [here](https://thinker227.github.io/Rascal/).



## Changelog

### API changes

- Rename `Result<T>.HasValue` to `IsOk`.

- Add `Result<T>.IsError`.

- Move error types into `Rascal.Errors` namespace.

- Add implicit conversion from `Error` to `Result<T>`.

- Add implicit conversion from `Exception` to `Error`.

- Add `object? key` parameter and `object? Key` property to `NotFoundError`.

- Add async version of `Prelude.Try`.

- Add async versions of `Result<T>.Match` and `Result<T>.Switch`.

- Rename `Result<T>.ToType` to `To` and allow attempting to convert to non-derived types.

- Add `ToString` extensions supporting `IFormattable`.

- Add `ResultEqualityComparer<T>`.

- Add additional overloads for `Result<T>.Equals` which allow specifying an equality comparer to use for comparing values.

- Rename `GetValueOrDefault(T @default)` and `GetValueOrDefault(Func<T> getDefault)` to `GetValueOr`.

- Add `Parse` extensions for `string` and `ReadOnlySpan<char>`.

### Analyzers and diagnostics

- Add analyzer and code-fix suite.

### Documentation

- Rewrite and update a lot of documentation.

- Create a documentation website.

0 comments on commit 51a50bf

Please sign in to comment.