objectionary#3160 add todo for refactoring

c71n93 · May 16, 2024 · 88d82de · 88d82de
1 parent b63ec99
commit 88d82de
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/eo-runtime/src/main/java/org/eolang/BytesOf.java b/eo-runtime/src/main/java/org/eolang/BytesOf.java
@@ -31,6 +31,11 @@
  * Bytes.
  *
  * @since 1.0
+ * @todo #3160:90min This class requires refactoring. As a result of refactoring you should remove
+ *  {@code @SuppressWarnings("PMD.GodClass")} from this class and
+ *  {@code @SuppressWarnings("PMD.CognitiveComplexity")} from {@link BytesOf#shift} method. You can
+ *  check description of this rules here
+ *  <a href="https://pmd.github.io/pmd/pmd_rules_java_design">pmd.github.io</a>
  */
 @Versionized
 @SuppressWarnings({"PMD.TooManyMethods", "PMD.GodClass"})

diff --git a/eo-runtime/src/main/java/org/eolang/Data.java b/eo-runtime/src/main/java/org/eolang/Data.java
@@ -197,6 +197,10 @@ private static Phi toPhi(final Object obj) {
          * @checkstyle JavaNCSSCheck (100 lines)
          * @checkstyle NestedIfDepthCheck (100 lines)
          * @checkstyle ModifiedControlVariableCheck (100 lines)
+         * @todo #3160:90min This method should be refactored because it has high cognitive
+         *  complexity and other problems. All {@code @checkstyle} warnings suppression and
+         *  {@code SuppressWarnings("PMD.WarningName")} annotations for this method should be
+         *  removed as a result of refactoring.
          */
         @SuppressWarnings({
             "PMD.AvoidReassigningLoopVariables",