From 60c56e2a6aaa7c986ee3defc112d2e10d6d27bae Mon Sep 17 00:00:00 2001 From: shannon Date: Mon, 22 May 2017 12:40:23 -0700 Subject: [PATCH] lint bookmarks app --- prospector-more.yml | 1 - readthedocs/bookmarks/models.py | 5 +++++ readthedocs/bookmarks/urls.py | 2 ++ readthedocs/bookmarks/views.py | 2 ++ 4 files changed, 9 insertions(+), 1 deletion(-) diff --git a/prospector-more.yml b/prospector-more.yml index e0f4dd58a85..7a67f8db097 100644 --- a/prospector-more.yml +++ b/prospector-more.yml @@ -4,7 +4,6 @@ strictness: medium ignore-paths: - api/ - - bookmarks/ - builds/ - cdn/ - comments/ diff --git a/readthedocs/bookmarks/models.py b/readthedocs/bookmarks/models.py index 333c5870142..5d700fd621a 100644 --- a/readthedocs/bookmarks/models.py +++ b/readthedocs/bookmarks/models.py @@ -1,3 +1,5 @@ +"""Models for the bookmarks app.""" + from django.db import models from django.contrib.auth.models import User from django.utils.translation import ugettext_lazy as _, ugettext @@ -7,6 +9,9 @@ class Bookmark(models.Model): + + """A user's bookmark of a ``Project``, ``Version``, and page.""" + user = models.ForeignKey(User, verbose_name=_('User'), related_name='bookmarks') project = models.ForeignKey(Project, verbose_name=_('Project'), diff --git a/readthedocs/bookmarks/urls.py b/readthedocs/bookmarks/urls.py index da40597375c..56192586cff 100644 --- a/readthedocs/bookmarks/urls.py +++ b/readthedocs/bookmarks/urls.py @@ -1,3 +1,5 @@ +"""URL config for the bookmarks app.""" + from django.conf.urls import url from readthedocs.bookmarks.views import BookmarkListView from readthedocs.bookmarks.views import BookmarkAddView, BookmarkRemoveView diff --git a/readthedocs/bookmarks/views.py b/readthedocs/bookmarks/views.py index 586b531bb97..98425600815 100644 --- a/readthedocs/bookmarks/views.py +++ b/readthedocs/bookmarks/views.py @@ -1,3 +1,5 @@ +"""Views for the bookmarks app.""" + from django.contrib.auth.decorators import login_required from django.http import HttpResponse, HttpResponseRedirect from django.http import HttpResponseBadRequest