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.
This commit is contained in:
Alan Orth 2020-09-24 12:06:27 +03:00
parent 495386856b
commit 21b500b4f7
Signed by: alanorth
GPG Key ID: 0FB860CC9C45B1B9
1 changed files with 6 additions and 2 deletions

View File

@ -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