Asterisk characters are not properly escaped in README.adoc
kiuxfr opened this issue · 5 comments
in the text. But was not able to make a pull request.
2 asteriks are not properly escaped in the text.
For making a pull request, see https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
As for the asterisks, we need more detail (specifically, the filename and line number).
Hi @kiuxfr. I see what you mean. In the README.adoc:
The two form fields, expressed with `th:field="*{id}"` and
`th:field="*{content}"`, correspond to the fields in the `Greeting` object.
Which renders to:
The two form fields, expressed with th:field="{id}" and th:field="{content}", correspond to the fields in the Greeting object.
Because of not escaping the *, the word and is bolded in our documentation. Another tip something isn't working.
I'm no expert in the matter, but played around and I think that escaping in this way should do the trick:
The two form fields, expressed with `th:field="+*+{id}"` and
`th:field="+*+{content}"`, correspond to the fields in the `Greeting` object.
Perhaps @Buzzardo has a better way. It isn't as simple as escaping with a /.
Seems like a good change for the community. I'll mark it as good for first time contributor.
It's been a while since you opened this issue, but I do hope you try again to submit a PR. In addition to the link @Buzzardo provided, I usually link people to this video by two Spring Engineers for an overview of the OSS process.
If anyone runs into problems submitting a PR let's continue the conversation.
Hi @robertmcnees, I will like toopen a PR for this issue. I see where the issue is in the documentation.
I created a Pr at #31
However I noticed that there is a single asterik befor "{id}"and "{content}"as seen below
th:field="*{id}" and th:field="*{content}"
Is this correct?
Please take a look at this @Buzzardo @robertmcnees
Looks good! I can see that the live documentation now includes this fix. Closing this issue. Thanks for the PR.