Skip to content

Commit a809593

Browse files
committed
more documentation changes
1 parent d2c8560 commit a809593

File tree

7 files changed

+17
-31
lines changed

7 files changed

+17
-31
lines changed

docs/activity.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Just subclass the Verb class and give it a unique id.
6464
register(Pin)
6565
6666
.. seealso:: Make sure your verbs are registered before you read data from feedly, if you use django
67-
you can just define/import them in models.py to make sure they are loaded early
67+
you can just define/import them in models.py to make sure they are loaded early
6868

6969

7070
Activity serialization

docs/background_tasks.rst

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -35,20 +35,16 @@ to scale up capacity less often.
3535
Feedly manager is the best place to implement your high/low priority fanouts, in fact the `get_follower_ids` method
3636
is required to return the feed ids grouped by priority.
3737

38-
eg.
39-
40-
```python
41-
42-
class MyFeedlyManager(Feedly):
43-
44-
def get_user_follower_ids(self, user_id):
45-
follower_ids = {
46-
FanoutPriority.HIGH: get_follower_ids(user_id, active=True),
47-
FanoutPriority.LOW: get_follower_ids(user_id, active=False)
48-
}
49-
return follower_ids
50-
51-
```
38+
eg::
39+
40+
class MyFeedlyManager(Feedly):
41+
42+
def get_user_follower_ids(self, user_id):
43+
follower_ids = {
44+
FanoutPriority.HIGH: get_follower_ids(user_id, active=True),
45+
FanoutPriority.LOW: get_follower_ids(user_id, active=False)
46+
}
47+
return follower_ids
5248

5349

5450
Celery and Django

docs/choosing_a_storage_backend.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ to store all the data in Redis. For larger use cases we therefor recommend Cassa
1414

1515

1616
Redis (2.7 or newer)
17-
******
17+
********************
1818

1919
PROS:
2020

@@ -48,7 +48,7 @@ In conclusion I believe Redis is your best bet if you can fallback to
4848
the database when needed.
4949

5050
Cassandra (2.0 or newer)
51-
******
51+
************************
5252

5353
PROS:
5454

docs/feedly.feeds.aggregated_feed.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ aggregated_feed Package
3333
:undoc-members:
3434
:show-inheritance:
3535

36-
:mod:`notificatoin_feed` Module
36+
:mod:`notification_feed` Module
3737
-------------------
3838

3939
.. automodule:: feedly.feeds.aggregated_feed.notification_feed

docs/feedly.rst

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,6 @@ feedly Package
3434
:undoc-members:
3535
:show-inheritance:
3636

37-
:mod:`marker` Module
38-
--------------------
39-
40-
.. automodule:: feedly.marker
41-
:members:
42-
:undoc-members:
43-
:show-inheritance:
44-
4537
:mod:`settings` Module
4638
----------------------
4739

feedly/feed_managers/base.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ class Feedly(object):
4949
to all their follower's feeds
5050
5151
.. note::
52-
5352
Fanout is the process which pushes a little bit of data to all of your
5453
followers in many small and asynchronous tasks.
5554
@@ -60,7 +59,7 @@ class Feedly(object):
6059
- user_feed_class
6160
6261
**Example** ::
63-
62+
6463
from feedly.feed_managers.base import Feedly
6564
6665
class PinFeedly(Feedly):
@@ -327,7 +326,7 @@ def fanout(self, user_ids, feed_class, operation, operation_kwargs):
327326
This functionality is called from within feedly.tasks.fanout_operation
328327
329328
:param user_ids: the list of user ids which feeds we should apply the
330-
operation against
329+
operation against
331330
:param feed_class: the feed to run the operation on
332331
:param operation: the operation to run on the feed
333332
:param operation_kwargs: kwargs to pass to the operation

feedly/feeds/base.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010

1111

1212
class BaseFeed(object):
13-
1413
'''
1514
The feed class allows you to add and remove activities from a feed.
1615
Please find below a quick usage example.
@@ -47,7 +46,7 @@ class MyFeed(BaseFeed):
4746
feed.filter(activity_id__lt=1)[:10]
4847
4948
50-
**Activity storage and Timeline storage**::
49+
**Activity storage and Timeline storage**
5150
5251
To keep reduce timelines memory utilization the BaseFeed supports
5352
normalization of activity data.

0 commit comments

Comments
 (0)