-
Notifications
You must be signed in to change notification settings - Fork 164
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
Use quoted section for preformatted text #2752
Comments
I found out there is right opposite definition in
But I still believe the text in the second figure below is better readable than the text in the first figure and vote for changing this rule. Figure 1 - snapshot of the current "Code" document: Figure 2 - the same document, code lines formated using blockquote: |
Are the blockquote tags missing in the 2nd example of the 2nd figure? Otherwise I wonder why it is indented w.r.t. the 1st figure. |
@beutlich Fixed 2nd figure. |
@tobolar Seems accepted.
|
You mean to go through all <pre>s? |
Yes. |
OK, I will look over it. |
I suggest to quote sections of preformated text in the documentation, in HTML by
<blockquote> ... </blockquote>
. This is already established in plenty of classes, but not consequently in all classes.If agreed, this should especially be documented in
Modelica.UsersGuide.Conventions.Documentation.Format.Code
.The text was updated successfully, but these errors were encountered: