Adding some documentation for clarity.

This commit is contained in:
Dan 2021-07-06 14:40:20 -04:00
parent cafdc4d100
commit a9805ad40c
2 changed files with 7 additions and 2 deletions

View File

@ -5,6 +5,12 @@ from crc.services.lookup_service import LookupService
class DocumentService(object):
"""The document service provides details about the types of documents that can be uploaded to a workflow.
This metadata about different document types is managed in an Excel spreadsheet, which can be uploaded at any
time to change which documents are accepted, and it allows us to categorize these documents. At a minimum,
the spreadsheet should contain the columns 'code', 'category1', 'category2', 'category3', 'description' and 'id',
code is required for all rows in the table, the other fields are optional. """
DOCUMENT_LIST = "irb_documents.xlsx"
@staticmethod

View File

@ -31,8 +31,7 @@ from crc.services.workflow_processor import WorkflowProcessor
class StudyService(object):
"""Provides common tools for working with a Study"""
"""Provides consistent management and rules for storing, retrieving and processing files."""
INVESTIGATOR_LIST = "investigators.xlsx"
INVESTIGATOR_LIST = "investigators.xlsx" # A reference document containing details about what investigators to show, and when.
@staticmethod
def get_studies_for_user(user):