-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Affects: io7m-com/.github#2
- Loading branch information
Showing
12 changed files
with
74 additions
and
771 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
|
||
## jequality | ||
|
||
The `jequality` package provides functions to compare floating-point numbers, | ||
annotations to mark classes as using specific types of equality, and a validator | ||
for equality methods. | ||
|
||
## Status | ||
|
||
As the Java platform evolves, libraries that may have been necessary in the | ||
past can become unnecessary due to new platform features. If you were already | ||
using `jequality`, then you know what it does and why you were using it. If | ||
you aren't already using `jequality`, then you should not start. | ||
|
||
This package is in maintenance mode and will not see any new functionality. | ||
|
||
Use [equalsverifier](https://jqno.nl/equalsverifier/) as a replacement for | ||
the `jequality` validator. | ||
|
||
Use JDK 17 record types to eliminate a lot of the issues with `equals()` and | ||
`hashCode()`. | ||
|
||
Use JUnit 5 assertions to perform approximate equality checks of floating-point | ||
values in unit tests. Outside of unit tests, find some other way to compare | ||
numbers. | ||
|
||
## Features | ||
|
||
* High coverage test suite. | ||
* Written in pure Java 21. | ||
* [OSGi-ready](https://www.osgi.org/) | ||
* [JPMS-ready](https://en.wikipedia.org/wiki/Java_Platform_Module_System) | ||
* ISC license. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
21 changes: 0 additions & 21 deletions
21
com.io7m.jequality.documentation/src/main/assembly/documentation.xml
This file was deleted.
Oops, something went wrong.
52 changes: 0 additions & 52 deletions
52
...equality.documentation/src/main/java/com/io7m/jequality/documentation/EDocumentation.java
This file was deleted.
Oops, something went wrong.
22 changes: 0 additions & 22 deletions
22
....jequality.documentation/src/main/java/com/io7m/jequality/documentation/package-info.java
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.