From edb753de1574db6257710e29016007dce0bb5d47 Mon Sep 17 00:00:00 2001 From: Burton DeWilde Date: Wed, 3 Aug 2016 13:01:42 -0400 Subject: [PATCH] Fixed docstrings for ReadTheDocs' sake --- textacy/corpora/supremecourt.py | 36 ++++++++++++++++----------------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/textacy/corpora/supremecourt.py b/textacy/corpora/supremecourt.py index e9536a48b..20343dce6 100644 --- a/textacy/corpora/supremecourt.py +++ b/textacy/corpora/supremecourt.py @@ -10,24 +10,24 @@ * text: full text of the Court's decision * case_name: name of the court case, in all caps * argument_date: date on which the case was argued before the Court, as a - string with format 'YYYY-MM-DD' + string with format 'YYYY-MM-DD' * decision_date: date on which the Court's decision was announced, as a - string with format 'YYYY-MM-DD' + string with format 'YYYY-MM-DD' * decision_direction: ideological direction of the majority decision; either - 'conservative', 'liberal', or 'unspecifiable' + 'conservative', 'liberal', or 'unspecifiable' * maj_opinion_author: name of the majority opinion's author, if available - and identifiable, as an integer code whose mapping is given in - `SupremeCourt.opinion_author_codes` + and identifiable, as an integer code whose mapping is given in + ``SupremeCourt.opinion_author_codes`` * n_maj_votes: number of justices voting in the majority * n_min_votes: number of justices voting in the minority * issue: subject matter of the case's core disagreement (e.g. affirmative - action) rather than its legal basis (e.g. the equal protection clause), - as a string code whose mapping is given in `SupremeCourt.issue_codes` + action) rather than its legal basis (e.g. the equal protection clause), + as a string code whose mapping is given in ``SupremeCourt.issue_codes`` * issue_area: higher-level categorization of the issue (e.g. Civil Rights), - as an integer code whose mapping is given in `SupremeCourt.issue_area_codes` + as an integer code whose mapping is given in ``SupremeCourt.issue_area_codes`` * us_cite_id: citation identifier for each case according to the official - United States Reports; Note: There are ~300 cases with duplicate ids, - and it's not clear if that's "correct" or a data quality problem + United States Reports; Note: There are ~300 cases with duplicate ids, + and it's not clear if that's "correct" or a data quality problem The text in this dataset was derived from FindLaw's searchable database of court cases: http://caselaw.findlaw.com/court/us-supreme-court @@ -40,12 +40,12 @@ This corpus' creation was inspired by a blog post by Emily Barry: http://www.emilyinamillion.me/blog/2016/7/13/visualizing-supreme-court-topics-over-time -.. warn:: The two datasets were merged through much munging and a carefully - trained model using the `dedupe` package. The model's duplicate threshold - was set so as to maximize the F-score where precision had twice as much - weight as recall. Still, given occasionally baffling inconsistencies in case - naming, citation ids, and decision dates, a very small percentage of texts - may be incorrectly matched to metadata. +NOTE: The two datasets were merged through much munging and a carefully +trained model using the ``dedupe`` package. The model's duplicate threshold +was set so as to maximize the F-score where precision had twice as much +weight as recall. Still, given occasionally baffling inconsistencies in case +naming, citation ids, and decision dates, a very small percentage of texts +may be incorrectly matched to metadata. """ import io import logging @@ -622,7 +622,7 @@ def texts(self, opinion_author=None, issue_area=None, decision_direction=None, Args: opinion_author (int or set[int]): filter cases by the name(s) of the majority opinion's author, coded as an integer whose mapping is - given in :meth:`author_opinion_codes ` + given in :meth:`opinion_author_codes ` issue_area (int or set[int]): filter cases by the issue area of the case's subject matter, coded as an integer whose mapping is given in :meth:`issue_area_codes ` @@ -661,7 +661,7 @@ def docs(self, opinion_author=None, issue_area=None, decision_direction=None, Args: opinion_author (int or set[int]): filter cases by the name(s) of the majority opinion's author, coded as an integer whose mapping is - given in :meth:`author_opinion_codes ` + given in :meth:`opinion_author_codes ` issue_area (int or set[int]): filter cases by the issue area of the case's subject matter, coded as an integer whose mapping is given in :meth:`issue_area_codes `