Skip to content

Commit 0726e15

Browse files
lordmauveagjohnson
authored andcommitted
Add missing module docstrings for gold app (#2873)
1 parent 67978b6 commit 0726e15

File tree

5 files changed

+16
-1
lines changed

5 files changed

+16
-1
lines changed

prospector-more.yml

-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ ignore-paths:
1010
- core/
1111
- doc_builder/
1212
- donate/
13-
- gold/
1413
- notifications/
1514
- payments/
1615
- privacy/

readthedocs/gold/__init__.py

+5
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1+
"""A Django app for Gold Membership.
2+
3+
Gold Membership is Read the Docs' program for recurring, monthly donations.
4+
5+
"""
16
default_app_config = 'readthedocs.gold.apps.GoldAppConfig'

readthedocs/gold/admin.py

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
"""Django admin configuration for the Gold Membership app."""
2+
13
from django.contrib import admin
24
from .models import GoldUser
35

readthedocs/gold/apps.py

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
"""Django app configuration for the Gold Membership app."""
2+
13
from django.apps import AppConfig
24

35

readthedocs/gold/models.py

+7
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
1+
"""Django models for recurring donations aka Gold Membership."""
12
import math
23

34
from django.db import models
45
from django.utils.translation import ugettext_lazy as _
56

67
from readthedocs.projects.models import Project
78

9+
10+
#: The membership options that are currently available
811
LEVEL_CHOICES = (
912
('v1-org-5', '$5/mo'),
1013
('v1-org-10', '$10/mo'),
@@ -14,10 +17,14 @@
1417
('v1-org-100', '$100/mo'),
1518
)
1619

20+
#: An estimate of the cost of supporting one project for a month
1721
DOLLARS_PER_PROJECT = 5
1822

1923

2024
class GoldUser(models.Model):
25+
26+
"""A user subscription for gold membership."""
27+
2128
pub_date = models.DateTimeField(_('Publication date'), auto_now_add=True)
2229
modified_date = models.DateTimeField(_('Modified date'), auto_now=True)
2330

0 commit comments

Comments
 (0)