Skip to content
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

Merged
merged 3 commits into from
Apr 12, 2024

Conversation

marcospereira
Copy link
Contributor

Depends on #341.

Copy link

codecov bot commented Apr 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.31%. Comparing base (149a085) to head (b5f92b7).

❗ Current head b5f92b7 differs from pull request most recent head bcc53d1. Consider uploading reports for the commit bcc53d1 to get more accurate results

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.
📢 Have feedback on the report? Share it here.

@marcospereira marcospereira marked this pull request as ready for review April 9, 2024 19:44
@marcospereira
Copy link
Contributor Author

@casid @kelunik, this is now rebased on top of main branch, and ready for review/merge. :-)

docs/gradle-plugin.md Outdated Show resolved Hide resolved
Comment on lines +66 to +67
| `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` |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `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` |

Copy link
Collaborator

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.

Copy link
Contributor Author

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.

Copy link
Collaborator

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.

Copy link
Contributor Author

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).
Copy link
Collaborator

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.

docs/gradle-plugin.md Outdated Show resolved Hide resolved
Comment on lines +129 to +130
| `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` |
Copy link
Collaborator

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.

docs/maven-plugin.md Show resolved Hide resolved
Co-authored-by: Niklas Keller <me@kelunik.com>
@casid casid merged commit 44903f1 into casid:main Apr 12, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants