Update quarkus-scheduler startMode documentation

[nderwin]

• removed the paragraph tags from the enum javadoc because they don't translate well into asciidoc and subsequently HTML tooltips
• potential fix for Tooltips for enum values are rendered incorrectly in documentation of configuration properties #36401

Signed-off-by:Nathan Erwin [email protected]

[quarkus-bot]

Thanks for your pull request!

The title of your pull request does not follow our editorial rules. Could you have a look?

• title should preferably start with an uppercase character (if it makes sense!)

_{This message is automatically generated by a bot.}

[github-actions]

🎊 PR Preview e6423a4 has been successfully built and deployed to https://quarkus-pr-main-36769-preview.surge.sh/version/main/guides/

[gsmet]

LGTM but I wonder if we should strip them automatically when transforming this to Asciidoc? That would avoid further breakages?

[nderwin]

LGTM but I wonder if we should strip them automatically when transforming this to Asciidoc? That would avoid further breakages?

I pondered that, but there was some discussion about if this code only produces Asciidoc for the config settings, or if it's used for other things where we'd want to leave the paragraph tags in there.

[quarkus-bot]

✔️ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

[michalvavrik]

LGTM but I wonder if we should strip them automatically when transforming this to Asciidoc? That would avoid further breakages?

+1, there is zero chance we can control this manually, sooner or later this will happen again

I pondered that, but there was some discussion about if this code only produces Asciidoc for the config settings, or if it's used for other things where we'd want to leave the paragraph tags in there.

I remember I had a way to do not add tooltip when it is not Asciidoc, therefore there should be also a way to only strip it when required. Unfortunately after that time I don't remember details. Let me try early next week rather than merging this fix. Thank you

[michalvavrik]

@nderwin I had a look and it's safe to strip <p> whenever is io.quarkus.annotation.processor.Constants#TOOLTIP used because then you know macro will be applied or description content won't be visible. Thank you for analysis and information. I think fixing it can be as simple as #37202. Sure, we can make it more robust, but IMHO it is not necessary (it must only cover how we write docs, not general case).