Fix minor text and comment issues

Author: JohT

jupyter/ExternalDependencies.ipynb

@@ -118,7 +118,7 @@
     "\n",
     "### External Package\n",
     "\n",
-    "A package is categorized as \"external\" if it is utilized as a dependency, or if any of its enclosed types are used as dependencies, but the code within it has not been analyzed (missing bytecode). This also applies to all build-in Java types, but they are explicitly filtered out here.\n",
+    "An external type has no `byteCodeVersion` since it only occurs as a dependency but wasn't analyzed itself (missing bytecode). Core Java types like `java.lang.Integer` and primitives like `int` are considered \"build-in\" and therefore aren't interpreted as \"external\" even though their byte code is also missing. A package is categorized as \"external\" if the types it contains are classified as external.\n",
     "\n",
     "### External annotation dependency\n",
     "\n",

jupyter/InternalDependencies.ipynb

@@ -128,7 +128,7 @@
     "These dependencies can lead to a lot of trouble when one of these packages needs to be changed.\n",
     "\n",
     "### Table 2\n",
-    "- List packages with cyclic dependencies"
+    "- List packages with cyclic dependencies as an overview"
    ]
   },
   {
@@ -150,7 +150,7 @@
    "metadata": {},
    "source": [
     "### Table 3\n",
-    "- List packages with cyclic dependencies with every dependency in a separate row sorted by the easiest and most valuable to resolve"
+    "- List packages with cyclic dependencies with every dependency in a separate row sorted by the easiest and most valuable resolvable dependency first"
    ]
   },
   {
@@ -189,7 +189,7 @@
     "\n",
     "If there are a couple of methods that are used for a distinct purpose, those could be factored out into a separate interface. The original type can extended/implement the new interface so that there are no breaking changes. Then all the callers, that use only this group of methods, can be changed to the new interface.\n",
     "\n",
-    "### Table 3\n",
+    "### Table 4\n",
     "- List top 20 most used combinations of methods of larger Types that might benefit from *Interface Segregation*"
    ]
   },
@@ -222,7 +222,7 @@
    "source": [
     "### Types that are used by multiple packages\n",
     "\n",
-    "#### Table 4\n",
+    "#### Table 5\n",
     "- List the top 20 packages that are used by the highest count of different packages "
    ]
   },
@@ -246,7 +246,7 @@
    "source": [
     "### Packages that are used by multiple artifacts\n",
     "\n",
-    "#### Table 5\n",
+    "#### Table 6\n",
     "- List the top 20 artifacts that only use a few (compared to all existing) packages of another artifact"
    ]
   },
@@ -270,7 +270,7 @@
    "source": [
     "### Packages that are used by multiple artifacts\n",
     "\n",
-    "#### Table 6\n",
+    "#### Table 7\n",
     "- List the top 20 packages that only use a few (compared to all existing) types of another package "
    ]
   },

jupyter/VisibilityMetrics.ipynb

@@ -139,7 +139,7 @@
     "\n",
     "Non public classes can't be accessed from another package so they can be changed without affecting code in other packages. They clearly indicate functionality that only belongs to one package. This also motivates to use more classes and to split up code into smaller pieces with a single responsibility and reason to change.\n",
     "\n",
-    "### Table 1\n",
+    "### Table 2\n",
     "\n",
     "- Show relative visibility statistics aggregated for all packages per artifact "
    ]
@@ -162,7 +162,7 @@
    "id": "3f59da8d",
    "metadata": {},
    "source": [
-    "### Table 2\n",
+    "### Table 3\n",
     "\n",
     "- List the top 40 packages and their artifact with the highest relative visibility"
    ]

scripts/executeJupyterNotebook.sh

@@ -19,6 +19,8 @@
 #       It it isn't activated, it will save the currently activated environment, change to codegraph, and restore the original one at the end again.
 #       In cases of an error it might be, that the original conda environment isn't set back. Typically this shouldn't be the case though. 
 
+# Requires juypter nbconvert
+
 SKIP_JUPYTER_NOTEBOOK_PDF_GENERATION=${SKIP_JUPYTER_NOTEBOOK_PDF_GENERATION:-""}
 
 # Check if environment variable is set

scripts/executeQuery.sh

@@ -15,7 +15,7 @@
 
 # Overrideable Defaults
 NEO4J_HTTP_PORT=${NEO4J_HTTP_PORT:-"7474"}
-NEO4J_HTTP_TRANSACTION_ENDPOINT=${NEO4J_HTTP_TRANSACTION_ENDPOINT:-"db/neo4j/tx/commit"} # Neo4j v5: "db/<name>/tx/commit", Neo4j v4: "db/data/transaction/commit",
+NEO4J_HTTP_TRANSACTION_ENDPOINT=${NEO4J_HTTP_TRANSACTION_ENDPOINT:-"db/neo4j/tx/commit"} # Neo4j v5: "db/<name>/tx/commit", Neo4j v4: "db/data/transaction/commit"
 
 # Check if environment variable is set
 if [ -z "${NEO4J_INITIAL_PASSWORD}" ]; then