Skip to content

Commit 7f6360a

Browse files
committed
Minor readme improvements
1 parent d7e72b8 commit 7f6360a

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
[![Build Status](https://travis-ci.org/ComputerScienceHouse/packet.svg?branch=develop)](https://travis-ci.org/ComputerScienceHouse/packet)
55

66
Packet is used by CSH to facilitate the freshmen packet portion of our introductory member evaluation process. This is
7-
the second major iteration of packet on the web. The first was [Tal packet](https://github.com/TalCohen/CSHWebPacket).
7+
the second major iteration of packet on the web. The first version was
8+
[Tal packet](https://github.com/TalCohen/CSHWebPacket).
89

910
## Setup
1011
**Requires Python 3.6 or newer.**
@@ -107,3 +108,6 @@ To run pylint use this command:
107108
```bash
108109
pylint packet
109110
```
111+
112+
All python files should have a top-level docstring explaining the contents of the file and complex functions should
113+
have docstrings explaining any non-obvious portions.

0 commit comments

Comments
 (0)