From d985efada970ad21f4e9776b13d062c8cfcd895f Mon Sep 17 00:00:00 2001 From: Josh Washburne Date: Fri, 29 Dec 2017 09:08:19 -0500 Subject: [PATCH] Added more docstrings. --- savepointradio/core/behaviors.py | 3 +++ savepointradio/core/migrations/0001_initial.py | 10 +++++----- savepointradio/core/models.py | 9 +++++---- 3 files changed, 13 insertions(+), 9 deletions(-) diff --git a/savepointradio/core/behaviors.py b/savepointradio/core/behaviors.py index b4bbf0c..71486b9 100644 --- a/savepointradio/core/behaviors.py +++ b/savepointradio/core/behaviors.py @@ -4,6 +4,9 @@ from django.utils.translation import ugettext_lazy as _ class Timestampable(models.Model): + """ + Mixin for keeping track of when an object was created and last modified. + """ created_date = models.DateTimeField(_('added on'), auto_now_add=True) modified_date = models.DateTimeField(_('last modified'), auto_now=True) diff --git a/savepointradio/core/migrations/0001_initial.py b/savepointradio/core/migrations/0001_initial.py index 648ccdd..7033013 100644 --- a/savepointradio/core/migrations/0001_initial.py +++ b/savepointradio/core/migrations/0001_initial.py @@ -1,4 +1,4 @@ -# Generated by Django 2.0 on 2017-12-27 21:02 +# Generated by Django 2.0 on 2017-12-29 13:36 from django.db import migrations, models import django.utils.timezone @@ -38,10 +38,10 @@ class Migration(migrations.Migration): name='Setting', fields=[ ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('name', models.CharField(max_length=64, unique=True)), - ('description', models.TextField(blank=True)), - ('setting_type', models.PositiveIntegerField(choices=[(0, 'Integer'), (1, 'Float'), (2, 'String'), (3, 'Bool')], default=0)), - ('data', models.TextField()), + ('name', models.CharField(max_length=64, unique=True, verbose_name='name')), + ('description', models.TextField(blank=True, verbose_name='description')), + ('setting_type', models.PositiveIntegerField(choices=[(0, 'Integer'), (1, 'Float'), (2, 'String'), (3, 'Bool')], default=0, verbose_name='variable type')), + ('data', models.TextField(verbose_name='data')), ], ), ] diff --git a/savepointradio/core/models.py b/savepointradio/core/models.py index 81a4a67..6ebc84d 100644 --- a/savepointradio/core/models.py +++ b/savepointradio/core/models.py @@ -31,11 +31,12 @@ class Setting(models.Model): (STRING, 'String'), (BOOL, 'Bool'), ) - name = models.CharField(max_length=64, unique=True) - description = models.TextField(blank=True) - setting_type = models.PositiveIntegerField(choices=TYPE_CHOICES, + name = models.CharField(_('name'), max_length=64, unique=True) + description = models.TextField(_('description'), blank=True) + setting_type = models.PositiveIntegerField(_('variable type'), + choices=TYPE_CHOICES, default=INTEGER) - data = models.TextField() + data = models.TextField(_('data')) def get(self): if self.setting_type == self.INTEGER: