Skip to content

Commit 777914b

Browse files
author
www-data
committed
Automated push from server made by Jared Broad
1 parent fe133f0 commit 777914b

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

08 Meta/01 Creating BootCamp Tutorials/06 Writing a Lesson.html

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -68,20 +68,27 @@ <h4>1. Write Lesson Algorithm</h4>
6868
Readability is critical and the code should be well commented with descriptive variable names. Depending on the complexity of the algorithm sometimes its more readable to use string tickers instead of class variables.
6969
</p>
7070
<p>
71-
Carefully write code in a way which neatly separates the algorithm concepts as much as possible. Keep in mind the algorithm will be implemented in tasks by the student.
71+
Carefully write code in a way which neatly separates the algorithm concepts as much as possible. Keep in mind the algorithm will be implemented in separate tasks by the student.
7272
</p>
73-
74-
<table style="table">
73+
<div class="tip">
74+
<i class="fa fa-bolt"></i><span class="tip-title">Action:</span>
75+
<p>Write highly readable, concise C# and Python versions of the algorithm and request review by QuantConnect Education team. Plan ahead for divisions of the code into tasks.</p>
76+
</div>
77+
78+
<h4>
79+
2. Write Task Guides
80+
</h4>
81+
<p>
82+
Each task has a short write up to explain the features need to complete next step of the BootCamp task. This guide should assume the student has no prior knowledge and include representitive code snippets demonstrating the key API code needed.
83+
</p>
84+
<table class="table">
7585
<thead>
76-
<tr><th>x</th><th> dx</th></tr>
86+
<tr><th style="width: 20%">Style</th><th>Code Tag</th></tr>
7787
</thead>
7888
<tbody>
79-
<tr><td>x</td></tr><tr><td>x</td></tr><tr><td>x</td></tr>
89+
<tr>
90+
<td><p>Headings</p></td>
91+
<td><pre class="prettyprint">&lt;h4&gt;Initializaing Algorithms&lt;/h4&gt;</pre> </td>
92+
</tr>
8093
</tbody>
81-
</table>
82-
83-
<ul style="border: 1px solid green">
84-
<li>Be Concise.</li>
85-
<li>Ensure Highly Readable.</li>
86-
<li>Keep Task Divisions in Mind.</li>
87-
</ul>
94+
</table>

0 commit comments

Comments
 (0)