diff options
Diffstat (limited to 'templates/site/tutorials')
| -rw-r--r-- | templates/site/tutorials/.description | 3 | ||||
| -rw-r--r-- | templates/site/tutorials/.links | 1 | ||||
| -rw-r--r-- | templates/site/tutorials/.secret/secretfile.txt | 1 | ||||
| -rw-r--r-- | templates/site/tutorials/how-to-make-this-site.html | 1 | ||||
| -rw-r--r-- | templates/site/tutorials/linux/linuz1.html | 1 | ||||
| -rw-r--r-- | templates/site/tutorials/python/.description | 1 | ||||
| -rw-r--r-- | templates/site/tutorials/python/py-style.html | 34 | ||||
| -rw-r--r-- | templates/site/tutorials/python/py-style.md | 91 | ||||
| -rw-r--r-- | templates/site/tutorials/python/test.py | 2 |
9 files changed, 0 insertions, 135 deletions
diff --git a/templates/site/tutorials/.description b/templates/site/tutorials/.description deleted file mode 100644 index ec41834..0000000 --- a/templates/site/tutorials/.description +++ /dev/null @@ -1,3 +0,0 @@ -There's a lot of tutorials out there that can show you something if you know -what to look for. Here's some tutorials that might help when you don't know -what to search. diff --git a/templates/site/tutorials/.links b/templates/site/tutorials/.links deleted file mode 100644 index a0e2e99..0000000 --- a/templates/site/tutorials/.links +++ /dev/null @@ -1 +0,0 @@ -Cool site,https://fsf.org diff --git a/templates/site/tutorials/.secret/secretfile.txt b/templates/site/tutorials/.secret/secretfile.txt deleted file mode 100644 index cae75f7..0000000 --- a/templates/site/tutorials/.secret/secretfile.txt +++ /dev/null @@ -1 +0,0 @@ -You shouldn't be able to see this file. It is a secret diff --git a/templates/site/tutorials/how-to-make-this-site.html b/templates/site/tutorials/how-to-make-this-site.html deleted file mode 100644 index 09dc877..0000000 --- a/templates/site/tutorials/how-to-make-this-site.html +++ /dev/null @@ -1 +0,0 @@ -<p>Carefully</p> diff --git a/templates/site/tutorials/linux/linuz1.html b/templates/site/tutorials/linux/linuz1.html deleted file mode 100644 index c299a06..0000000 --- a/templates/site/tutorials/linux/linuz1.html +++ /dev/null @@ -1 +0,0 @@ -Linux is cool diff --git a/templates/site/tutorials/python/.description b/templates/site/tutorials/python/.description deleted file mode 100644 index d69e5c3..0000000 --- a/templates/site/tutorials/python/.description +++ /dev/null @@ -1 +0,0 @@ -Some basics and thoughts on Python diff --git a/templates/site/tutorials/python/py-style.html b/templates/site/tutorials/python/py-style.html deleted file mode 100644 index 62de1ba..0000000 --- a/templates/site/tutorials/python/py-style.html +++ /dev/null @@ -1,34 +0,0 @@ -<h1 id="coding-style-guide">Coding Style Guide</h1> -<p>The purpose of this document is twofold: 1) To ensure that anyone who might like to make my code better understands why I write python the way I do 2) to ensure <em>I</em> adhere to my own style because I’m terribly inconsistent</p> -<p>Being terribly inconsistent, the guidelines are not set in stone and if you have a good argument for doing things a particular, I don’t really care.</p> -<p><em>BUT</em> first and foremost, <em>code must comply with PEP8 first</em>. This is easy to automate. I like coala since it’s friendly but there’ plenty of advanced linters out there.</p> -<p>That aside, I have the following idiosyncracies:</p> -<h2 id="strings-are-double-quoted.-keys-and-chars-are-single-quoted.">1) <em>Strings</em> are <em>double-quoted</em>. <em>Keys</em> and <em>chars</em> are <em>single-quoted</em>.</h2> -<p>This is really just because I like how C does it. And Cpython’s C-based so why not?</p> -<p>Like so: <code>code string = "This is a phrase" word = "word" cur_char = 'a' newline = '\n' # note, two characters, but it's still ONE char in output # keys are single-quoted to avoid confusion dictionary = { 'key' : "1245dqw3w431", 'return': newline }</code></p> -<p>The only exception is for strings with quotes in them (anything to avoid escapes, really) <code>code quoted_string = ( '"You miss 100% of the shots you don't take - Wayne Gretsky" - Michael Scott' )</code> That brings me to my next point.</p> -<h2 id="long-strings-belong-in-parentheses">2) Long strings belong in parentheses</h2> -<p>As in:</p> -<pre class="code"><code>longboi = ( - "This is a really long string usefull when making help menus. Be\n" - "sure to leave s space at the end of each line, or add a new line\n" - "when needed.\n" - - "Try your best to keep formatting accurate like this." -)</code></pre> -<h2 id="tabs-are-four-spaces-and-spaces-are-always-prefered-to-tabs">3) Tabs are four spaces and spaces are <em>ALWAYS</em> prefered to tabs</h2> -<p>Again, see PEP8.</p> -<h2 id="always-add-spaces-between-arithmetic-but-never-for-brackets">4) Always add spaces between arithmetic, but never for brackets</h2> -<p>It’s a pain to read: <code>code 1/(2*sqrt(pi))*exp(x**2)</code> Do this <code>code 1 / (2 * sqrt(pi)) * exp(x ** 2)</code> The same goes for logic operators <code>code true & false ^ true</code></p> -<h2 id="everything-should-be-snake_case">5) EVERYTHING should be snake_case</h2> -<p>This is python. Unless there’s a compatibility thing (like a library’s code was written that way, or it matches an API variable), snake_case is preferred.</p> -<pre class="code"><code>user_input = int(input()) # variable -MAX_INPUT = 1000 # constant -def judge_input(_input, _max): # function - if _max > _input: - print("Too big!") - -judge_input(user_input, MAX_INPUT -class Input_Judger: # a class - # etc etc</code></pre> -<p>Example exception <code>code # this doesn't actually work, but you get the idea r = requests.get("www.debian.org") pageSize = r.json()['pageSize'] # camel case ok</code></p> diff --git a/templates/site/tutorials/python/py-style.md b/templates/site/tutorials/python/py-style.md deleted file mode 100644 index bf96f59..0000000 --- a/templates/site/tutorials/python/py-style.md +++ /dev/null @@ -1,91 +0,0 @@ -# Coding Style Guide - -The purpose of this document is twofold: -1) To ensure that anyone who might like to make my code better understands - why I write python the way I do -2) to ensure *I* adhere to my own style because I'm terribly inconsistent - -Being terribly inconsistent, the guidelines are not set in stone and if -you have a good argument for doing things a particular, I don't really care. - -*BUT* first and foremost, *code must comply with PEP8 first*. This is easy -to automate. I like coala since it's friendly but there' plenty of advanced -linters out there. - -That aside, I have the following idiosyncracies: - -## 1) *Strings* are *double-quoted*. *Keys* and *chars* are *single-quoted*. - -This is really just because I like how C does it. And Cpython's C-based so -why not? - -Like so: - ```code - string = "This is a phrase" - word = "word" - cur_char = 'a' - newline = '\n' # note, two characters, but it's still ONE char in output - # keys are single-quoted to avoid confusion - dictionary = { 'key' : "1245dqw3w431", 'return': newline } - ``` - -The only exception is for strings with quotes in them (anything to avoid -escapes, really) - ```code - quoted_string = ( - '"You miss 100% of the shots you don't take - Wayne Gretsky" - Michael Scott' - ) - ``` -That brings me to my next point. - -## 2) Long strings belong in parentheses - -As in: -```code -longboi = ( - "This is a really long string usefull when making help menus. Be\n" - "sure to leave s space at the end of each line, or add a new line\n" - "when needed.\n" - - "Try your best to keep formatting accurate like this." -) -``` - -## 3) Tabs are four spaces and spaces are *ALWAYS* prefered to tabs -Again, see PEP8. - -## 4) Always add spaces between arithmetic, but never for brackets -It's a pain to read: - ```code - 1/(2*sqrt(pi))*exp(x**2) - ``` -Do this - ```code - 1 / (2 * sqrt(pi)) * exp(x ** 2) - ``` -The same goes for logic operators - ```code - true & false ^ true - ``` - -## 5) EVERYTHING should be snake_case -This is python. Unless there's a compatibility thing (like a library's -code was written that way, or it matches an API variable), -snake_case is preferred. -```code -user_input = int(input()) # variable -MAX_INPUT = 1000 # constant -def judge_input(_input, _max): # function - if _max > _input: - print("Too big!") - -judge_input(user_input, MAX_INPUT -class Input_Judger: # a class - # etc etc -``` -Example exception -```code -# this doesn't actually work, but you get the idea -r = requests.get("www.debian.org") -pageSize = r.json()['pageSize'] # camel case ok``` - diff --git a/templates/site/tutorials/python/test.py b/templates/site/tutorials/python/test.py deleted file mode 100644 index 83b87a6..0000000 --- a/templates/site/tutorials/python/test.py +++ /dev/null @@ -1,2 +0,0 @@ -#!/usr/bin/python3 -print("hi") |