Skip to content
This repository was archived by the owner on Aug 9, 2024. It is now read-only.

Commit c6cc8d8

Browse files
committed
Fixes documentation generation Warning/Errors for CI.
1 parent 764b968 commit c6cc8d8

7 files changed

Lines changed: 23 additions & 13 deletions

File tree

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@
2020
import sys
2121

2222
import alabaster
23-
import revscoring
2423

2524
dir_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
2625
print(dir_path)
2726
sys.path.insert(0, dir_path)
2827

28+
import revscoring
2929

3030
# -- General configuration ------------------------------------------------
3131

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
revscoring.datasources.session_oriented
2+
=======================================
3+
4+
.. automodule:: revscoring.datasources.session_oriented

revscoring/datasources/__init__.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,6 @@
2323
++++++++++++
2424
.. automodule:: revscoring.datasources.datasource
2525
26-
27-
28-
2926
"""
3027
from .datasource import Datasource
3128

revscoring/datasources/session_oriented.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@
77
"""
88
import re
99

10-
from revscoring import Datasource, Feature
10+
from revscoring import Feature, FeatureVector
1111
from revscoring.features.meta import expanders as feature_expanders
1212

1313
from ..dependencies import DependentSet
14+
from .datasource import Datasource
1415
from .meta import expanders as datasource_expanders
1516
from .revision_oriented import Revision, User
1617

@@ -45,6 +46,9 @@ def list_of_ify(dependent, rewrite_name, cache):
4546
if isinstance(dependent, Datasource):
4647
return datasource_expanders.list_of(
4748
dependent, depends_on=new_dependencies, name=new_name)
49+
elif isinstance(dependent, FeatureVector):
50+
return datasource_expanders.list_of(
51+
dependent, depends_on=new_dependencies, name=new_name)
4852
elif isinstance(dependent, Feature):
4953
return feature_expanders.list_of(
5054
dependent, depends_on=new_dependencies, name=new_name)

revscoring/features/__init__.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,6 @@
4949
++++++++++++
5050
5151
.. automodule:: revscoring.features.feature
52-
53-
.. automodule:: revscoring.features.feature_vector
5452
"""
5553

5654
from .feature import Constant, ConstantVector, Feature, FeatureVector, Modifier

revscoring/features/feature.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,18 @@
22
.. autoclass:: revscoring.Feature
33
:members:
44
5+
.. autoclass:: revscoring.FeatureVector
6+
:members:
7+
58
.. autoclass:: revscoring.features.Modifier
69
:members:
710
811
.. autoclass:: revscoring.features.Constant
912
:members:
13+
14+
.. autoclass:: revscoring.features.ConstantVector
15+
:members:
16+
1017
"""
1118
import operator
1219
from itertools import repeat

revscoring/features/meta/aggregators.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ def sum(items_datasource, name, returns, empty_default, vector=False):
157157
def len(items_datasource, name, returns, empty_default, vector=False):
158158
return len_builtin, name, int, empty_default or 0
159159
len.__doc__ = """
160-
Constructs a :class:`revscoring.Features` that returns the length of a
160+
Constructs a :class:`revscoring.Feature` that returns the length of a
161161
collection of items.
162162
163163
:Parameters:
@@ -177,7 +177,7 @@ def mean(items_datasource, name, returns, empty_default, vector=False):
177177
returns = returns or float
178178
return statistics.mean, name, returns, empty_default or 0.0
179179
mean.__doc__ = """
180-
Constructs a :class:`revscoring.Features` that returns the mean of a
180+
Constructs a :class:`revscoring.Feature` that returns the mean of a
181181
collection of items.
182182
183183
:Parameters:
@@ -196,7 +196,7 @@ def mean(items_datasource, name, returns, empty_default, vector=False):
196196
def max(items_datasources, name, returns, empty_default, vector=False):
197197
return max_builtin, name, returns or float, empty_default or 0
198198
max.__doc__ = """
199-
Constructs a :class:`revscoring.Features` that returns the maximum of a
199+
Constructs a :class:`revscoring.Feature` that returns the maximum of a
200200
collection of items.
201201
202202
:Parameters:
@@ -215,7 +215,7 @@ def max(items_datasources, name, returns, empty_default, vector=False):
215215
def min(items_datasources, name, returns, empty_default, vector=False):
216216
return min_builtin, name, returns or float, empty_default or 0
217217
min.__doc__ = """
218-
Constructs a :class:`revscoring.Features` that returns the minimum of a
218+
Constructs a :class:`revscoring.Feature` that returns the minimum of a
219219
collection of items.
220220
221221
:Parameters:
@@ -234,7 +234,7 @@ def min(items_datasources, name, returns, empty_default, vector=False):
234234
def first(items_datasource, name, returns, empty_default, vector=False):
235235
return _first, name, returns or float, empty_default or None
236236
first.__doc__ = """
237-
Constructs a :class:`revscoring.Features` that returns the first of a
237+
Constructs a :class:`revscoring.Feature` that returns the first of a
238238
collection of items.
239239
240240
:Parameters:
@@ -253,7 +253,7 @@ def first(items_datasource, name, returns, empty_default, vector=False):
253253
def last(items_datasource, name, returns, empty_default, vector=False):
254254
return _last, name, returns or float, empty_default or None
255255
last.__doc__ = """
256-
Constructs a :class:`revscoring.Features` that returns the last of a
256+
Constructs a :class:`revscoring.Feature` that returns the last of a
257257
collection of items.
258258
259259
:Parameters:

0 commit comments

Comments
 (0)