You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+7-19
Original file line number
Diff line number
Diff line change
@@ -87,35 +87,23 @@ All variables are imported from the package root as follows:
87
87
88
88
The available variables are:
89
89
90
-
- ``REPORTERS`` — This is the main database and contains a huge dict of
91
-
reporters as described below.
90
+
- ``REPORTERS`` — This is the main database and contains a huge dict of reporters as described below.
92
91
93
-
- ``LAWS`` — Our database of statutory abbreviations, mapping the statute
94
-
abbreviations to their metadata. For example ``Ark. Reg`` is the abbreviation
95
-
for the ``Arkansas Register``.
92
+
- ``LAWS`` — Our database of statutory abbreviations, mapping the statute abbreviations to their metadata. For example ``Ark. Reg`` is the abbreviation for the ``Arkansas Register``.
96
93
97
94
- ``JOURNALS`` — Same idea as ``LAWS``, but for legal journal abbreviations.
98
95
99
-
- ``STATE_ABBREVIATIONS`` — Bluebook style abbreviations for each state. For
100
-
example, ``Ala.`` for Alaska and ``Haw.`` for Hawaii.
96
+
- ``STATE_ABBREVIATIONS`` — Bluebook style abbreviations for each state. For example, ``Ala.`` for Alaska and ``Haw.`` for Hawaii.
101
97
102
-
- ``CASE_NAME_ABBREVIATIONS`` — Bluebook style abbreviations for common words,
103
-
mapping each abbreviation to a list of possible words. For example, ``Admin``
104
-
maps to ``["Administrative", "Administration"]``.
98
+
- ``CASE_NAME_ABBREVIATIONS`` — Bluebook style abbreviations for common words, mapping each abbreviation to a list of possible words. For example, ``Admin`` maps to ``["Administrative", "Administration"]``.
105
99
106
100
A few specialized reporter-related variables are:
107
101
108
-
- ``VARIATIONS_ONLY`` — This contains a dict mapping a canonical reporter
109
-
abbreviation to a list of possible variations it could represent. For example,
110
-
``A. 2d`` sometimes incorrectly lacks a space, and has a variation list of
111
-
``["A.2d"]``. ``P.R.`` could be ``["Pen. & W.", "P.R.R.", "P."]``.
102
+
- ``VARIATIONS_ONLY`` — This contains a dict mapping a canonical reporter abbreviation to a list of possible variations it could represent. For example, ``A. 2d`` sometimes incorrectly lacks a space, and has a variation list of ``["A.2d"]``. ``P.R.`` could be ``["Pen. & W.", "P.R.R.", "P."]``.
112
103
113
-
- ``EDITIONS`` — A simple dict to map the abbreviations for each reporter
114
-
edition to the canonical reporter. For example, ``A.2d`` maps to ``A.``.
104
+
- ``EDITIONS`` — A simple dict to map the abbreviations for each reporter edition to the canonical reporter. For example, ``A.2d`` maps to ``A.``.
115
105
116
-
- ``NAMES_TO_EDITIONS`` — A simple dict to map the name of a reporter back to
117
-
its canonilcal abbreviations. For example, ``Atlantic Reporter`` maps to
118
-
``['A.', 'A.2d']``.
106
+
- ``NAMES_TO_EDITIONS`` — A simple dict to map the name of a reporter back to its canonilcal abbreviations. For example, ``Atlantic Reporter`` maps to ``['A.', 'A.2d']``.
0 commit comments