Skip to content

Commit

Permalink
Correction in the documentation of PEVersion: Accuracy in the content…
Browse files Browse the repository at this point in the history
… and grammar whilst ensuring clarity.
  • Loading branch information
retrooper committed Jul 9, 2024
1 parent b0fa4eb commit ba7d09e
Showing 1 changed file with 7 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@
/**
* Represents a PacketEvents version using Semantic Versioning.
* Supports version comparison, cloning, and provides a string representation.
* Snapshots will always resolve to a newer version than the non-snapshot version if major, minor, and patch are the same.
* Snapshot versioning is also supported.
* Generally a snapshot version is published before the release version,
* and thus, is considered "older" than the release version.
*/
public class PEVersion implements Comparable<PEVersion> {

Expand Down Expand Up @@ -178,8 +180,8 @@ public boolean snapshot() {

/**
* Gets the snapshot commit hash. May be of any length.
* May always be present or absent, doesn't matter
* wether this is a snapshot version or not.
* Availability is not guaranteed.
* Additionally, its presence is not contingent on this being a snapshot version.
*
* @return the snapshot commit hash, if available.
*/
Expand All @@ -191,7 +193,7 @@ public boolean snapshot() {
* Compares this {@link PEVersion} with another {@link PEVersion}.
*
* @param other the other {@link PEVersion}.
* @return a negative integer, zero, or a positive integer as this version is less than,
* @return a negative integer, zero, or a positive integer as this version can be less than,
* equal to, or greater than the specified version.
*/
@Override
Expand Down Expand Up @@ -281,7 +283,7 @@ public String toString() {

/**
* Converts the {@link PEVersion} to an array of version numbers.
*
* @deprecated since {@link PEVersion} instances now always use Semantic Versioning.
* @return an array of version numbers.
*/
@Deprecated
Expand Down

0 comments on commit ba7d09e

Please sign in to comment.