Skip to content

Added docstring to init #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all 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
11 changes: 11 additions & 0 deletions caduceus/sorter.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
class SnakeSorter:
def __init__(self, snakes):
'''
Reads in the data stored in two files and builds a list of snakes

Args:
common_file: a csv file mapping common names to scientific
names of snakes
sci_file: a csv file listing scientific names of snakes with
lengths and weights

Returns: an unsorted list of Snake items
'''
self.snakes = snakes
self.sorted_snakes = []

Expand Down