Merge pull request #218 from takahirom/takahirom/introduce-writerside…

…-documentation/2023-12-03 Fix writerside errors
takahirom · Dec 3, 2023 · 6807a0b · 6807a0b
2 parents 6d485ec + ee641b3
commit 6807a0b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 7 deletions.
diff --git a/docs/topics/faq.md b/docs/topics/faq.md
@@ -70,9 +70,8 @@ By following these steps, you should be able to identify and resolve the issue c
 
 **A:** This warning may occur with Gradle 7.5. Upgrade to Gradle 7.6.2 to resolve this issue. Change the distribution URL in `gradle-wrapper.properties`:
 
-```diff
--distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-bin.zip
-+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.2-bin.zip
+```
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.2-bin.zip
 ```
 
 ### Q: Can I run Roborazzi with Bazel?

diff --git a/docs/topics/how_to_use.md b/docs/topics/how_to_use.md
@@ -741,7 +741,7 @@ You can configure the following options in your `gradle.properties` file:
 This option enables you to configure the behavior of Roborazzi. By default, all settings are set to false.
 For additional configuration options, please refer to the 'Apply Roborazzi Gradle Plugin' section.
 
-```properties
+```
 roborazzi.test.record=true
 # roborazzi.test.compare=true
 # roborazzi.test.verify=true
@@ -753,15 +753,15 @@ roborazzi.test.record=true
 
 This option lets you set the resize scale for the image being recorded. The default value is 1.0.
 
-```properties
+```
 roborazzi.record.resizeScale=0.5
 ```
 
 #### roborazzi.record.filePathStrategy
 
 This setting allows you to specify the file path strategy for the recorded image. The default strategy is `relativePathFromCurrentDirectory`. If you choose `relativePathFromRoborazziContextOutputDirectory`, the file will be saved in the output directory specified by `RoborazziRule.Options.outputDirectoryPath`.
 
-```properties
+```
 roborazzi.record.filePathStrategy=relativePathFromRoborazziContextOutputDirectory
 ```
 
@@ -773,6 +773,6 @@ This option enables you to define the naming strategy for the recorded image. Th
 - If you choose `escapedTestPackageAndClassAndMethod`, the file name will be `com_example_MyTest.testMethod.png`.
 - If you choose `testClassAndMethod`, the file name will be `MyTest.testMethod.png`.
 
-```properties
+```
 roborazzi.record.namingStrategy=testClassAndMethod
 ```