Skip to content

Commit 434dd2c

Browse files
[Docs] Added docstrings and examples to a lot of classes (#1206)
* added docsstrings to boundingBox class * add docstrings to Layer class * added docstrings for Dataset and RemoteDataset classes * more doc strings * disable parameter headings in docs * converted several other docstrings into google style format * add docstrings for Annotation class * more doc strings * fix formatting --------- Co-authored-by: Norman Rzepka <[email protected]>
1 parent 73c02bd commit 434dd2c

File tree

14 files changed

+2122
-656
lines changed

14 files changed

+2122
-656
lines changed

docs/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ plugins:
9292
show_symbol_type_toc: true
9393
show_if_no_docstring: true
9494
signature_crossrefs: true
95+
parameter_headings: false
9596
summary: true
9697
unwrap_annotated: true
9798
line_length: 60

docs/uv.lock

Lines changed: 0 additions & 186 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)