-
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
Tweak docs #313
Tweak docs #313
Conversation
Welcome @MariusVolkhart and thanks for your contributions! IMHO this note is a bit misleading: jte-models generates an additional facade so that templates can be called through that facade. But behind the scenes it either calls the templates dynamically and compiles them on demand (good for development, bad for production), or it calls the previously generated/precompiled template methods (bad for development, good for production). |
Fair point! I was trying to convey that when using the generate stage at build time, you can't also use the pre-compile stage. I found myself spending a fair bit of time trying to wrap my head around the relationship/tradeoff between binary encoding, precompile on-disk, precompile in classpath, and generated models. I'll work on the wording for this. |
@@ -52,7 +52,7 @@ Example usage with `HttpServletResponse`: | |||
=== "Kotlin" | |||
|
|||
```kotlin linenums="1" | |||
val output = new Utf8ByteOutput() |
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.
Good catch!
I'm actually trying to find the time to externalize the code samples in .java
/.kt
files that are compiled. It is supported by MkDocs, and it would be easier to maintain. We can also externalize the template examples.
Fix some Kotlin code, correct an indent level, cross-reference the various combinations of pre-compiling, binary encoding, and facade generation.
2dc2fd5
to
fe37e8b
Compare
@casid I took another stab at this, this time linking more liberally between the strategies (binary encoding, pre-compiled, and facade). I would appreciate you giving this another look and any feedback you might have. |
Looks good, thank you so much! |
Fix some Kotlin code, correct an indent level, and provide some more info on how model code generation replaces precompiled templates.