-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Add flag to show both configuration styles (Java and XML) in reference docs #572
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
Conversation
I tested this PR and noticed that the "Both" option will introduce some repetitive sentences making the documentation not coherent: Moreover, we need to make sure every section having a role corresponds to its snippet and test it with the "Both" option to avoid inconsistencies like the following one: To be honest, I don't see the added value of this "Both" option, at least with the current design. May be we can update the style to show snippets side by side, but still. |
Those are errors we need to correct. I'll make a new PR for them. |
Do you want an issue for this or is it too simple for that? |
No need for an issue or a new PR. You can fix those in this PR so we merge a coherent change set at once. |
Hi, Mahmoud, That was tricky. I had to rephrase a bit to make it make sense and still keep the key information. I also fixed a couple grammatical errors that I caught while I was there. Please check this commit closely, as I had to resolve a bunch of conflicts due to the age of the original commit. I THINK I got everything right, but please do check. Thanks much. |
@Buzzardo Thank you for all these updates! I did a quick check and it looks ok now. Let's iterate on this. Could you please rebase the PR on the latest master branch? Thank you upfront. |
I edited the leader paragraphs above each code block that was flagged as being XML or Java content, such that the paragraphs make sense when both the XML and the Java blocks are present. I turned the Both button back on. I also caught a bunch of other editing things.
Mahmoud Ben Hassine caught a couple of sentences that were problematic when the Both option is on. I then caught a couple of other problems. I fixed all of that. Thanks for reading closely, Mahmoud. I always appreciate that.
@benas I have rebased and cleared up all the conflicts. |
I edited the leader paragraphs above each code block that was flagged as being XML or Java content, such that the paragraphs make sense when both the XML and the Java blocks are present. I turned the Both button back on. I also caught a bunch of other editing things.