Add missing Javadoc + update README #70
Conversation
xhaggi
changed the title
README.md
Outdated
| .addTemplate("users :: list") | ||
| .addTemplate("users :: count"); | ||
| .addTemplate("user-list") | ||
| .addTemplate("user-count"); |
There was a problem hiding this comment.
Why the removal of the :: notation? That is a common usage with partials. (At least in my experience) I recommend keeping them since it can be a hiccup for folks new to Thymeleaf.
There was a problem hiding this comment.
Because they are Thymeleaf specific and this part of the documentation is no longer Thymeleaf related. It could be confusing for users like me who use another template engine, e.g. FreeMarker.
There was a problem hiding this comment.
I understand your point @xhaggi , but I would like to keep such an example in the docs for those of that do use Thymeleaf so they know a partial fragment can be used there. Not sure if we can somehow combine the examples or just add a 2nd example, indicating that it is Thymeleaf specific?
There was a problem hiding this comment.
I have added a new sub-section "Markup Selectors and Out Of Band Swaps" under the "Thymleaf" section explaining this in more detail.
|
Looks good to me. Just the merge conflict and the remark about the docs and this can be merged. Thank you for your work! |
xhaggi
force-pushed
the
missing-javadoc
branch
from
785552b
to
6a30911
Compare
|
Mind taking another look, especially at the new section "Markup Selectors and Out Of Band Swaps". |
* Inform about available annotations * Explain Thymeleaf Markup Selector usage * Link to javadoc.io
xhaggi
force-pushed
the
missing-javadoc
branch
from
6a30911
to
005c931
Compare
No description provided.