Skip to content

Commit 58d0f43

Browse files
committed
Further refines the interface and updates the docs to reflect changes
1 parent 9abbf38 commit 58d0f43

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

docs/source/usage.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,15 @@ Options
4444
SC2Reader behavior can be configured with a number of options which can either
4545
be specified individually by keyword argument or packaged into a dictionary::
4646

47-
from sc2reader import config
47+
import sc2reader
4848
4949
options = dict(
5050
'processors': [PostProcessor],
51-
'parse': config.PARTIAL,
51+
'parse': sc2reader.PARTIAL,
5252
'directory':'C:\Users\Me\Documents...',
5353
)
5454
55-
reader = SC2Reader(processors=[PostProcessor],parse=config.PARTIAL)
55+
reader = SC2Reader(processors=[PostProcessor],parse=sc2reader.PARTIAL)
5656
sc2reader.config(**options)
5757
5858
Options currently available are described below:
@@ -80,7 +80,7 @@ Options currently available are described below:
8080

8181
.. option:: parse
8282

83-
Three parse levels are provided in the ``sc2reader.config`` package:
83+
Three parse levels are provided for general convenience:
8484

8585
* ``FULL`` parse will parse through all available files and produce the
8686
most comprehensive replay object.

sc2reader/__init__.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@
88

99
__version__ = "0.3.0"
1010

11+
FULL = "FULL"
12+
PARTIAL = "PARTIAL"
13+
CUSTOM = "CUSTOM"
14+
1115
FILES = {
1216
"FULL": [
1317
'replay.initData',

0 commit comments

Comments
 (0)