Skip to content

Commit

Permalink
#343 Drop passive voice from docs
Browse files Browse the repository at this point in the history
to improve clarity and readability.
  • Loading branch information
ascheman committed Feb 24, 2025
1 parent 87782e2 commit 8d62e2b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
15 changes: 8 additions & 7 deletions htmlSanityCheck-cli/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Alternatively,

== Usage

The CLI tool can be executed with the following command.
Execute the CLI tool with the following command.
If the `sourceDirectory` is omitted, HSC uses the current directory as base-directory to search for HTML files.

Linux / macOS::
Expand All @@ -56,7 +56,7 @@ hsc.bat [ options ] [ sourceDirectory ]
The CLI tool exposes a few options as part of its configuration:

[horizontal]
<sourceDirectory> (optional):: Directory where the HTML files are located.
<sourceDirectory> (optional):: HSC searches this directory for HTML files.
+
Type: Directory
+
Expand All @@ -75,13 +75,13 @@ Type: Directory
Default: `./reports/htmlSanityCheck/`

`--junitResultsDir` <...> (optional):: Directory where HSC writes the results in JUnit XML format.
JUnit XML can be read by many tools, including CI environments.
Many tools can read JUnit XML, including CI environments.
+
Type: Directory
+
Default: `./test-results/htmlchecks/`

`--failOnErrors` (optional):: Fail the build if any error was found in the checked pages.
`--failOnErrors` (optional):: Fail the build if HSC detected any error in the checked pages.
+
Type: Boolean
+
Expand Down Expand Up @@ -134,7 +134,8 @@ include::../htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/tools/W
[NOTE]
.HTTP Redirects
====
Note that HTTP redirects are treated as a warning to make the user aware of the correct or new location (cf. {project-issues}/244[Issue 244]).
Note that HSC treats HTTP redirects as a warning to make the user aware of the correct
or new location (cf.{nbsp}{project-issues}/244[Issue 244]).
Some HSC reports contain the respective location.
====

Expand All @@ -149,7 +150,7 @@ Default:
include::../htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/tools/Web.java[tag=HTTP_ERROR_CODES,indent=0]
----

`--httpSuccessCodes` (optional):: HTTP response codes treated as success.
`--httpSuccessCodes` (optional):: HTTP response codes that HSC treats as success.
+
Type: List
+
Expand Down Expand Up @@ -190,7 +191,7 @@ java -jar htmlSanityCheck-cli-<version>.jar \

== Compatibility

The CLI tool has been tested with the following Java versions:
We test the HSC CLI tool with the following Java versions:

* Java 8
* Java 11
Expand Down
3 changes: 1 addition & 2 deletions src/docs/development/publishing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,7 @@ gpg: Sorry, we are in batchmode - can't get input
FAILURE: Build failed with an exception.
----
In this case, you have to make sure you started the agent and cached the password,
e.g., by executing
In this case, you have to start the agent and cache the password, e.g., by executing
[source,shell]
----
Expand Down

0 comments on commit 8d62e2b

Please sign in to comment.