Skip to content

Commit 25735e1

Browse files
committed
added description to 'Document' class
1 parent c7bf15f commit 25735e1

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

RTC.py

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -285,13 +285,21 @@ def cosponsors(cls, bill_id, make_obj=False, sections=('cosponsors',)):
285285
return [i for i in bill['cosponsors']]
286286

287287
class Documents(RTC_Client):
288+
"""
289+
Holds links to various kinds of documents produced
290+
by agencies within Congress, or agencies outside of Congress regarding
291+
legislation and related matters.
292+
293+
This collection currently contains only one kind of document:
288294
289-
# currently, the posted_at is the only guarenteed field
290-
# it used a timestamp format, which requires the url
291-
# to display it twice to do a '__gte' and '__lte'
295+
whip_notice - Daily and weekly digests of chamber schedules published by
296+
House leadership of each party.
297+
298+
"""
292299

293300
@classmethod
294301
def get_by_date(cls, date, make_obj=False, sections=''):
302+
"""Ex: RTC.Documents.get_by_date('2011-03-14')"""
295303
endpoint = "documents.json"
296304
begin_time = '%sT00:00:00' % date
297305
end_time = '%sT23:59:59' % date

0 commit comments

Comments
 (0)