From 2cb1e3281700095f2753f2c06dddd283034007c6 Mon Sep 17 00:00:00 2001 From: James Seibel Date: Sat, 26 Aug 2023 12:04:00 -0500 Subject: [PATCH] Minor DhApi rename and comment cleanup --- .../main/java/com/seibel/distanthorizons/api/DhApi.java | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/api/src/main/java/com/seibel/distanthorizons/api/DhApi.java b/api/src/main/java/com/seibel/distanthorizons/api/DhApi.java index f1a15bd5a..2d3fe0d16 100644 --- a/api/src/main/java/com/seibel/distanthorizons/api/DhApi.java +++ b/api/src/main/java/com/seibel/distanthorizons/api/DhApi.java @@ -26,7 +26,7 @@ import com.seibel.distanthorizons.coreapi.interfaces.dependencyInjection.IOverri * the concrete object we replaced, there would be issues. * * @author James Seibel - * @version 2023-6-29 + * @version 2023-8-26 * @since API 1.0.0 */ public class DhApi @@ -49,9 +49,10 @@ public class DhApi "and suggested setup. \n" + // DH Dev note: no links were included to prevent link rot. ""; /** @apiNote Don't use the result of this method in your code. It may change and is only for reference. */ - public static String getReadMe() { return READ_ME; } + public static String readMe() { return READ_ME; } /** - * This is just a humorous way to reference the {@link DhApi#READ_ME} constant string. + * This is just a humorous way to reference the {@link DhApi#READ_ME} constant string and hopefully peak a few people's attention + * vs the relatively boring "readMe". * @apiNote Don't use the result of this method in your code. It may change and is only for reference. */ public static String heyYou_YoureFinallyAwake() { return READ_ME; }