From 097a09b3dda4bb907437d125b9174d113dc82f4d Mon Sep 17 00:00:00 2001
From: "J.-S. Caux" <J.S.Caux@uva.nl>
Date: Thu, 10 Jan 2019 12:05:16 +0100
Subject: [PATCH] Correct docstrings in journals/models.py
---
.../migrations/0054_auto_20190110_1204.py | 26 +++++++++++++++++++
journals/models.py | 10 ++++---
2 files changed, 32 insertions(+), 4 deletions(-)
create mode 100644 journals/migrations/0054_auto_20190110_1204.py
diff --git a/journals/migrations/0054_auto_20190110_1204.py b/journals/migrations/0054_auto_20190110_1204.py
new file mode 100644
index 000000000..9c08d3941
--- /dev/null
+++ b/journals/migrations/0054_auto_20190110_1204.py
@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.4 on 2019-01-10 11:04
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('journals', '0053_auto_20181118_1758'),
+ ]
+
+ operations = [
+ migrations.AlterField(
+ model_name='issue',
+ name='in_journal',
+ field=models.ForeignKey(blank=True, help_text='Assign either a Volume or Journal to the Issue', null=True, on_delete=django.db.models.deletion.CASCADE, related_name='issues', to='journals.Journal'),
+ ),
+ migrations.AlterField(
+ model_name='issue',
+ name='in_volume',
+ field=models.ForeignKey(blank=True, help_text='Assign either a Volume or Journal to the Issue', null=True, on_delete=django.db.models.deletion.CASCADE, related_name='issues', to='journals.Volume'),
+ ),
+ ]
diff --git a/journals/models.py b/journals/models.py
index edb53ca78..fbb513676 100644
--- a/journals/models.py
+++ b/journals/models.py
@@ -190,7 +190,8 @@ class Journal(models.Model):
class Volume(models.Model):
"""
- A Volume may be used as a subgroup of Publications related to a specific Issue object.
+ A Volume belongs to a specific Journal, and is a container for
+ either (multiple) Issue(s) or Publication(s).
"""
in_journal = models.ForeignKey('journals.Journal', on_delete=models.CASCADE)
number = models.PositiveSmallIntegerField()
@@ -255,14 +256,15 @@ class Volume(models.Model):
class Issue(models.Model):
"""
- An Issue may be used as a subgroup of Publications related to a specific Journal object.
+ An Issue is related to a specific Journal, either indirectly via a Volume
+ container, or directly. It is a container for multiple Publications.
"""
in_journal = models.ForeignKey(
'journals.Journal', on_delete=models.CASCADE, null=True, blank=True,
- help_text='Assign either an Volume or Journal to the Issue')
+ help_text='Assign either a Volume or Journal to the Issue')
in_volume = models.ForeignKey(
'journals.Volume', on_delete=models.CASCADE, null=True, blank=True,
- help_text='Assign either an Volume or Journal to the Issue')
+ help_text='Assign either a Volume or Journal to the Issue')
number = models.PositiveSmallIntegerField()
slug = models.SlugField()
start_date = models.DateField(default=timezone.now)
--
GitLab