docs: add about github output format detection

quarylabs · Sep 26, 2024 · e5d8ccb · e5d8ccb
1 parent 4be1ab3
commit e5d8ccb
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -74,7 +74,7 @@ pip install sqruff
 
 #### GitHub Action
 
-You can also use the GitHub Action to install and run sqruff in your CI/CD pipeline.
+You can also use the GitHub Action to install and run sqruff in your CI/CD pipeline. Inside a Github Action, `sqruff` automatically outputs linting output in the GitHub format so that it can be easily viewed in the PR tab.
 
 ```yaml
 jobs:

diff --git a/editors/code/README.md b/editors/code/README.md
@@ -74,7 +74,7 @@ pip install sqruff
 
 #### GitHub Action
 
-You can also use the GitHub Action to install and run sqruff in your CI/CD pipeline.
+You can also use the GitHub Action to install and run sqruff in your CI/CD pipeline. Inside a Github Action, `sqruff` automatically outputs linting output in the GitHub format so that it can be easily viewed in the PR tab.
 
 ```yaml
 jobs:
-Original file line number
+Diff line change
@@ Expand Up / @@ -74,7 +74,7 @@ pip install sqruff @@
     #### GitHub Action
-    You can also use the GitHub Action to install and run sqruff in your CI/CD pipeline.
+    You can also use the GitHub Action to install and run sqruff in your CI/CD pipeline. Inside a Github Action, `sqruff` automatically outputs linting output in the GitHub format so that it can be easily viewed in the PR tab.
     ```yaml
     jobs:
@@ Expand Down @@