Skip to content
Open
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------------
'''

This comment was marked as outdated.

This comment was marked as outdated.

```

## 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:

Expand All @@ -68,3 +80,6 @@ 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
All documents will be signed as
> With love, 🦄s, and 🐘s by the CS41 Staff