Skip to content

Commit 263bd6c

Browse files
committed
Adds code overview SVG contributed by Jvdjvdjvd
1 parent e8b7581 commit 263bd6c

File tree

4 files changed

+117
-1
lines changed

4 files changed

+117
-1
lines changed

dicomtrolley/qido_rs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,7 @@ def check_for_response_errors(response):
374374

375375
@classmethod
376376
def ensure_query_type(cls, query: Query) -> QidoRSQueryBase:
377-
"""Make sure query is of a type usable in this searcher. Cast if needed
377+
"""Make sure query is of a type usable in this searcher. Cast if needed.
378378
379379
Separate casting method needed in addition to Query.init_from_query()
380380
To properly handle the two QIDO-RS query types

docs/code.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Code
2+
3+
Information about the code structure of dicomtrolley. Meant for developers seeking to
4+
[contribute](contributing.md) to the project. For quick examples see [usage](usage.md).
5+
For a more high-level overview of dicomtrolley concepts see [concepts](concepts.md).
6+
7+
## Code documentation
8+
You can find documentation and code for all python classes in the [API reference](reference/SUMMARY.md)
9+
10+
## Class structure
11+
Python class relations for some core dicomtrolley classes.
12+
13+
[![object types diagram](resources/object_types_trolley.svg)](resources/object_types_trolley.svg)

docs/resources/object_types_trolley.svg

Lines changed: 102 additions & 0 deletions
Loading

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ nav:
55
- Usage: usage.md
66
- Concepts: concepts.md
77
- Authentication: authentication.md
8+
- Code: code.md
89
- Contributing: contributing.md
910
- API Reference: reference/dicomtrolley/*
1011

0 commit comments

Comments
 (0)