fail_plan.rb in bolt-2.0.0

- old
+ new

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 require 'bolt/error'
 
-# Raises a Bolt::PlanFailure exception to signal to callers that the plan failed.
+# Raises a `Bolt::PlanFailure` exception to signal to callers that the plan failed.
 #
 # Plan authors should call this function when their plan is not successful. The
-# error may then be caught by another plans run_plan function or in bolt itself
+# error may then be caught by another plans `run_plan` function or in Bolt itself
 #
-# **NOTE:** Not available in apply block
+# > **Note:** Not available in apply block
 Puppet::Functions.create_function(:fail_plan) do
   # Fail a plan, generating an exception from the parameters.
   # @param msg An error message.
   # @param kind An easily matchable error kind.
   # @param details Machine-parseable details about the error.