Add a comment explaining a change

openrewrite · Jan 9, 2024 · f231a2e · f231a2e
1 parent 1f49794
commit f231a2e
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/src/main/kotlin/org/openrewrite/RecipeMarkdownGenerator.kt b/src/main/kotlin/org/openrewrite/RecipeMarkdownGenerator.kt
@@ -166,7 +166,7 @@ class RecipeMarkdownGenerator : Runnable {
             val docLink =
                 docBaseUrl + recipeDescriptor.name.lowercase(Locale.getDefault()).removePrefix("org.openrewrite.")
                     .replace('.', '/')
-                    .replace("$", "usd")
+                    .replace("$", "usd") // needed for refaster templates + gitbook as we have started using $ in our recipe descriptors :(
 
             val recipeSource = recipeDescriptor.source.toString()
             var isImperative = true