From ef958a5a09d09985232c272c5dcd170713a4dfb6 Mon Sep 17 00:00:00 2001
From: Martijn Vermaat <martijn@vermaat.name>
Date: Sun, 27 Sep 2015 18:59:34 +0200
Subject: [PATCH] Improve docstrings in transcript-protein link queries
---
mutalyzer/db/queries.py | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/mutalyzer/db/queries.py b/mutalyzer/db/queries.py
index 230804d7..7f28cf5e 100644
--- a/mutalyzer/db/queries.py
+++ b/mutalyzer/db/queries.py
@@ -62,7 +62,8 @@ def get_transcript_protein_link(accession, reverse=False):
according to the configuration settings `PROTEIN_LINK_EXPIRATION` and
`NEGATIVE_PROTEIN_LINK_EXPIRATION`.
- :arg str accession: Accession number to lookup link for.
+ :arg str accession: Accession number (without version number) to lookup
+ link for.
:arg bool reverse: If `True`, `accession` is assumed to be a protein
accession number, otherwise `accession` is assumed to be a transcript
accession number.
@@ -101,6 +102,14 @@ def update_transcript_protein_link(transcript_accession=None,
"""
Update cached link between a transcript and a protein, or create it if it
doesn't exist yet.
+
+ :arg str transcript_accession: Transcript accession number (without
+ version number).
+ :arg str protein_accession: Protein accession number (without version
+ number).
+
+ At least one of `transcript_accession` or `protein_accession` must be not
+ `None`.
"""
if transcript_accession is None and protein_accession is None:
raise ValueError('Link must have a transcript or protein')
--
GitLab