-
Notifications
You must be signed in to change notification settings - Fork 69
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Add new docs page for Gradle Plugin #346
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #346 +/- ##
============================================
- Coverage 91.38% 91.31% -0.07%
+ Complexity 1219 1218 -1
============================================
Files 76 76
Lines 3168 3168
Branches 493 493
============================================
- Hits 2895 2893 -2
- Misses 163 164 +1
- Partials 110 111 +1 ☔ View full report in Codecov by Sentry. |
b5f92b7
to
5f2dc41
Compare
| `htmlCommentsPreserved` | If HTML comments should be preserved in the output | `false` | | ||
| `binaryStaticContent` | If to generate a [binary content](binary-rendering.md) resource for each template | `false` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| `htmlCommentsPreserved` | If HTML comments should be preserved in the output | `false` | | |
| `binaryStaticContent` | If to generate a [binary content](binary-rendering.md) resource for each template | `false` | | |
| `htmlCommentsPreserved` | Whether HTML comments should be preserved in the output | `false` | | |
| `binaryStaticContent` | Whether to generate a [binary content](binary-rendering.md) resource for each template | `false` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure about these, but if to
sounds really strange.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
English is not my first language, so it may indeed be strange. However, it is consistent with the javadoc comments. If we decide to adjust here, I would rather adjust the javadoc comments and the Maven plugin docs page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not a native speaker either.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Grammarly seems okay with this phrasing. I think we can leave it like this.
|
||
!!! warning "Clean all before precompiling" | ||
|
||
The `precompileJte` task cleans the directory containing the compiled template classes every time it runs. In your local development environment, it may make more sense to use [hot reloading](hot-reloading.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same comment here as in the other PR: The hint to hot reloading seems unrelated to the Clean all before precompiling
warning.
| `htmlCommentsPreserved` | If HTML comments should be preserved in the output | `false` | | ||
| `binaryStaticContent` | If to generate a [binary content](binary-rendering.md) resource for each template | `false` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same regarding if
vs. whether
applies here.
Co-authored-by: Niklas Keller <[email protected]>
Depends on #341.