Skip to content

Commit

Permalink
Merge pull request #1 from amhokies/patch-1
Browse files Browse the repository at this point in the history
Fixing missing comma in README documentation
  • Loading branch information
kevincianfarini authored Jan 17, 2017
2 parents 6ea61e1 + cac20ae commit 666098b
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![Coverage Status](https://coveralls.io/repos/github/kevincianfarini/pyvt/badge.svg?branch=master)](https://coveralls.io/github/kevincianfarini/pyvt?branch=master)
[![Build Status](https://travis-ci.org/kevincianfarini/pyvt.svg?branch=master)](https://travis-ci.org/kevincianfarini/pyvt)
[![PyPI version](https://badge.fury.io/py/py-vt.svg)](https://badge.fury.io/py/py-vt)


A Virginia Tech Timetable of Classes Python API
Expand All @@ -28,7 +29,7 @@ timetable = Timetable()
The timetable object provides some useful methods for pulling data from the VT Timetable.

```python
timetable.crn_lookup('17583', term_year='201701' open_only=False)
timetable.crn_lookup('17583', term_year='201701', open_only=False)
```

returns the class section object from the timetable with the CRN 17583 in the term year `201701`, regardless of whether or not the class is full to capacity. Alternatively if you would like to only find sections that are open:
Expand Down Expand Up @@ -103,9 +104,9 @@ Alternatively, if you know that a certain term year is available but not the def
```python
term_years = {
'Spring 2017': '201701',
'Summer I 2017', '201706',
'Summer II 2017', '201707',
'Fall 2017', '201708',
'Summer I 2017': '201706',
'Summer II 2017': '201707',
'Fall 2017': '201708',
...
}
```
Expand Down Expand Up @@ -133,4 +134,4 @@ except TimetableError as e:
time.sleep(e.sleep_time)
```

The idea behind this is that if the request was bad, your program will sleep for a short amount of time. However if the VT Timetable is down, and multiple successive ```TimetableErrors``` are raised, then ```sleep_time``` grows exponentially to avoid overwhelming the server.
The idea behind this is that if the request was bad, your program will sleep for a short amount of time. However if the VT Timetable is down, and multiple successive ```TimetableErrors``` are raised, then ```sleep_time``` grows exponentially to avoid overwhelming the server.

0 comments on commit 666098b

Please sign in to comment.