Skip to content

Commit ed4ec8d

Browse files
author
hackermd
committed
Improve documentation of QIDO-RS methods
Add link to relevant tables in the standard documents that specify the returned attributes for QIDO-RS response messages.
1 parent c21df22 commit ed4ec8d

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

src/dicomweb_client/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
__version__ = '0.3.0'
1+
__version__ = '0.3.1rc'
22

33
from dicomweb_client.api import DICOMWebClient

src/dicomweb_client/api.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -591,7 +591,8 @@ def search_for_studies(self, fuzzymatching=None, limit=None, offset=None,
591591
Returns
592592
-------
593593
List[Dict[str, dict]]
594-
matching instances
594+
study representations
595+
(see `returned attributes <http://dicom.nema.org/medical/dicom/current/output/chtml/part18/sect_6.7.html#table_6.7.1-2>`_)
595596
596597
'''
597598
url = self._get_studies_url()
@@ -700,7 +701,8 @@ def search_for_series(self, study_instance_uid=None, fuzzymatching=None,
700701
Returns
701702
-------
702703
List[Dict[str, dict]]
703-
matching instances
704+
series representations
705+
(see `returned attributes <http://dicom.nema.org/medical/dicom/current/output/chtml/part18/sect_6.7.html#table_6.7.1-2a>`_)
704706
705707
'''
706708
url = self._get_series_url(study_instance_uid)
@@ -793,7 +795,8 @@ def search_for_instances(self, study_instance_uid=None,
793795
Returns
794796
-------
795797
List[Dict[str, dict]]
796-
matching instances
798+
instance representations
799+
(see `returned attributes <http://dicom.nema.org/medical/dicom/current/output/chtml/part18/sect_6.7.html#table_6.7.1-2b>`_)
797800
798801
'''
799802
url = self._get_instances_url(study_instance_uid, series_instance_uid)

0 commit comments

Comments
 (0)