summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTrupti Rajesh Kini2016-05-17 11:27:09 +0530
committerTrupti Rajesh Kini2016-05-17 11:27:09 +0530
commitbf6b1581a34df4b62e1ddc2cc888c511fffe2fc5 (patch)
treeac042bcd6cb35a01d7aa037fa0b423e9660471e8
parentca3b877ea02a41af6e42d576fbb53ff852a458d7 (diff)
parent86ff63ec0b1b3f631b03fb85b521a3ccb62fe201 (diff)
downloadPython-TBC-Interface-bf6b1581a34df4b62e1ddc2cc888c511fffe2fc5.tar.gz
Python-TBC-Interface-bf6b1581a34df4b62e1ddc2cc888c511fffe2fc5.tar.bz2
Python-TBC-Interface-bf6b1581a34df4b62e1ddc2cc888c511fffe2fc5.zip
Merge pull request #36 from FOSSEE/kinitrupti-guidelines
Updated Guidelines
-rw-r--r--tbc/static/templates/guidelines.html4
1 files changed, 2 insertions, 2 deletions
diff --git a/tbc/static/templates/guidelines.html b/tbc/static/templates/guidelines.html
index 6d283b4..ed43197 100644
--- a/tbc/static/templates/guidelines.html
+++ b/tbc/static/templates/guidelines.html
@@ -3,7 +3,7 @@
<li>IPython Notebook version 1.1.0 or higher should be used (which supports user input)
<li>Each chapter should be an individual IPython Notebook
<li>A notebook should start with Chapter number followed by chapter name which should be in font size of ‘heading 1’ available in IPytho Notebook
- <li>The above point should be followed by a cell which consists of Example number and the page number which should be in font size of ‘heading 2’ available in IPytho Notebook
+ <li>The above point should be followed by a cell which consists of Example number and the page number which should be in font size of ‘heading 2’ available in IPython Notebook
<li>Same variables should be used in the codes as given in the textbook. In few cases, if this point doesn’t hold true, then the contributor may use any variable of his/her choice but an appropriate comment is necessary giving a description of the quantity.
<li>Libraries must be imported in all examples. Import specific libraries only and avoid import *.
<li>Round-off the final answers according to the textbook
@@ -11,7 +11,7 @@
<li>Do not use reference Figures/Diagrams given in the book anywhere in your code. All the outputs must be displayed in appropriate format (along with units mentioned).
<li>Appropriate comments should be put, which will make the code easily understandable. The comments should help in highlighting the flow of logic being used. For example, the equation like R = V/I can have comment as "Ohm's Law" along with it.
<li>All the plots must be named and have appropriate labels on its axes.
- <li>The plots/graphs should not open in a separate window; rather they should be a part of the output. A command ‘%pylab inline’ does the work.
+ <li>The plots/graphs should not open in a separate window; rather they should be a part of the output. A command ‘%matplotlib inline’ does the work.
<li>The symbols used in the code should be same as those being used in the textbook
<li>Check for using correct formulae while using in-built functions. (For example, the angles must be converted to degree (or radians) before calculating the sine or cosine etc.)
<li>The codes should follow the naming convention as given below, for example, For chapter number 4, the file name must be chapter4.ipynb