Skip to content

Commit 7e6c547

Browse files
committed
Establish a standard for the use of blank lines to separate sections
Blank lines were used inconsistently and unnecessarily in the reference example. I have attempted to decipher the intended spacing standard and apply this across the document. This proposal establishes an official style. If accepted, I will apply it across all the reference pages, where this sort of inconsistency is widespread.
1 parent afde77c commit 7e6c547

File tree

1 file changed

+1
-6
lines changed

1 file changed

+1
-6
lines changed

AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Single_Entity.adoc

+1-6
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ subCategories: [ "Subcategory Name" ]
1212

1313

1414

15-
16-
1715
// PAGE TITLE
1816
= title
1917

@@ -56,7 +54,6 @@ Nothing
5654

5755

5856

59-
6057
// HOW TO USE SECTION STARTS
6158
[#howtouse]
6259
--
@@ -66,7 +63,6 @@ Nothing
6663
// Describe what the example code is all about and add relevant code ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄
6764
Sets the output to the LED proportional to the value read from the potentiometer.
6865

69-
7066
[source,arduino]
7167
// Add relevant code that exemplify the use of the Reference term,
7268
// Please note that sometimes when copy-pasting code, a few spaces can be added at the beginnng of each line of code.
@@ -102,6 +98,7 @@ image::http://arduino.cc/en/uploads/Main/ArduinoUno_R3_Front_450px.jpg[caption="
10298
// HOW TO USE SECTION ENDS
10399

104100

101+
105102
// SEE ALSO SECTION
106103
[#see_also]
107104
--
@@ -112,7 +109,6 @@ image::http://arduino.cc/en/uploads/Main/ArduinoUno_R3_Front_450px.jpg[caption="
112109
// definitions: (please add the tag #DEFINITION#), and examples of Projects and Tutorials
113110
// examples: (please add the tag #EXAMPLE#)
114111

115-
116112
[role="language"]
117113
// Whenever you want to link to another Reference term, or more in general to a relative link,
118114
// use the syntax shown below. Please note that the file format is subsituted by attribute.
@@ -133,4 +129,3 @@ image::http://arduino.cc/en/uploads/Main/ArduinoUno_R3_Front_450px.jpg[caption="
133129

134130
--
135131
// SEE ALSO SECTION ENDS
136-

0 commit comments

Comments
 (0)