Skip to content

Commit

Permalink
rss_feeds.py: data() docstring
Browse files Browse the repository at this point in the history
Attempt to explain why we override this function.
I...actually don't understand why we do, so this explanation may be wrong.
It seems like we could have fit within the BaseDocketReport framework
of returning our information as `docket_entries` rather than `data` but
maybe I'm missing something.
  • Loading branch information
johnhawkinson committed May 18, 2018
1 parent 42bc6d8 commit a978447
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions juriscraper/pacer/rss_feeds.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,8 @@ def _parse_text(self, text):

@property
def data(self):
"""Override this to create a list of docket-like objects instead of the
usual dict that is usually provided by the docket report.
"""Return a list of docket-like objects instead of the usual dict that
is usually provided by the BaseDocketReport superclass.

This comment has been minimized.

Copy link
@mlissner

mlissner May 18, 2018

Member

The reason for this is that it keeps life simple if we treat each RSS item as a docket unto itself and then return a list of dockets from this function. The nice thing about doing it that way is that in CourtListener, we just apply all of our usual merging code on each docket in the list and we're all set without thinking twice about some kind of new JSON object.

"""
if self._data is not None:
return self._data
Expand Down

0 comments on commit a978447

Please sign in to comment.