From 21b500b4f77148bd7d6717da845021bbdbe2e446 Mon Sep 17 00:00:00 2001 From: Alan Orth Date: Thu, 24 Sep 2020 12:06:27 +0300 Subject: [PATCH] dspace_statistics_api/util.py: Use docstring for get_statistics_shards It seems better to use a docstring instead of a comment because it can potentially be used by IDEs or documentation generators. --- dspace_statistics_api/util.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/dspace_statistics_api/util.py b/dspace_statistics_api/util.py index eda10ab..ff6823d 100644 --- a/dspace_statistics_api/util.py +++ b/dspace_statistics_api/util.py @@ -1,6 +1,10 @@ -# Enumerate the cores in Solr to determine if statistics have been sharded into -# yearly shards by DSpace's stats-util or not (for example: statistics-2018). def get_statistics_shards(): + """Enumerate the cores in Solr to determine if statistics have been sharded into + yearly shards by DSpace's stats-util or not (for example: statistics-2018). + + Returns: + str:A list of Solr statistics shards separated by commas. + """ from .config import SOLR_SERVER import re