From 20f00d3e21afaac0a64105a6f5cb94bf4b10ed1f Mon Sep 17 00:00:00 2001 From: Michael Cooper Date: Sun, 23 Aug 2020 10:30:33 -0700 Subject: [PATCH 1/2] Added filename and signature style regulations --- STYLE.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/STYLE.md b/STYLE.md index 30273da..e100776 100644 --- a/STYLE.md +++ b/STYLE.md @@ -42,6 +42,18 @@ expression_that_prints_something # Line 3 of output ``` +## Filenames + +When indicating code that is written in a `.py` file, the following lines should appear at the top of the code block; the separating `-`s should reach exactly to the end of the `.py` extension in the filename, as below. +```python +# /usr/bin/env python3 + +''' +File: filename.py +----------------- +''' +``` + ## Images All images should include alt text and be centered in the screen with a caption. The height should be specified and is generally 350. This can be done in Github with the following HTML code: @@ -68,3 +80,10 @@ Think "this is how Python does X" instead of "here's how to do X in Python." ## Accessibility These notes should be written to be friendly to people using assistive technologies to access the website. In particular, make sure that the notes make sense read aloud. Introduce code blocks and images with signpost language like "The image below depicts..." or "In Python, it's valid to write...". +## Signature +When Parth is the primary author of a document, the signature should appear as follows: +> With ❤️ and 🦄 by @psarin and @cooper-mj +When Michael is the primary author of a document, the signature should appear as follows: +> With ❤️ and 🐘 by @cooper-mj and @psarin +When Parth and Michael are approximately equivalent co-authors of a document, the signature should appear as follows: +> With ❤️, 🦄, and 🐘 by @cooper-mj and @psarin From 8946938b0a798e275b979211724c79026149d482 Mon Sep 17 00:00:00 2001 From: Parth Sarin Date: Sun, 23 Aug 2020 17:35:20 -0500 Subject: [PATCH 2/2] Update signature per our discussion See meeting agenda for 8/23/20 --- STYLE.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/STYLE.md b/STYLE.md index e100776..3bd78e8 100644 --- a/STYLE.md +++ b/STYLE.md @@ -81,9 +81,5 @@ Think "this is how Python does X" instead of "here's how to do X in Python." These notes should be written to be friendly to people using assistive technologies to access the website. In particular, make sure that the notes make sense read aloud. Introduce code blocks and images with signpost language like "The image below depicts..." or "In Python, it's valid to write...". ## Signature -When Parth is the primary author of a document, the signature should appear as follows: -> With ❤️ and 🦄 by @psarin and @cooper-mj -When Michael is the primary author of a document, the signature should appear as follows: -> With ❤️ and 🐘 by @cooper-mj and @psarin -When Parth and Michael are approximately equivalent co-authors of a document, the signature should appear as follows: -> With ❤️, 🦄, and 🐘 by @cooper-mj and @psarin +All documents will be signed as +> With love, 🦄s, and 🐘s by the CS41 Staff