Skip to content

Document all functions in ocr/ and add relevant type signatures #1033

Document all functions in ocr/ and add relevant type signatures

Document all functions in ocr/ and add relevant type signatures #1033

Triggered via pull request January 15, 2025 20:31
Status Failure
Total duration 45s
Artifacts

lint.yaml

on: pull_request
Fit to window
Zoom out
Zoom in

Annotations

10 errors and 2 warnings
Ruff (D100): OCR/ocr/api.py#L1
OCR/ocr/api.py:1:1: D100 Missing docstring in public module
Ruff (D103): OCR/ocr/api.py#L37
OCR/ocr/api.py:37:5: D103 Missing docstring in public function
Ruff (D103): OCR/ocr/api.py#L51
OCR/ocr/api.py:51:5: D103 Missing docstring in public function
Ruff (D103): OCR/ocr/api.py#L57
OCR/ocr/api.py:57:11: D103 Missing docstring in public function
Ruff (D103): OCR/ocr/api.py#L62
OCR/ocr/api.py:62:11: D103 Missing docstring in public function
Ruff (D103): OCR/ocr/api.py#L72
OCR/ocr/api.py:72:11: D103 Missing docstring in public function
Ruff (D103): OCR/ocr/api.py#L118
OCR/ocr/api.py:118:11: D103 Missing docstring in public function
Ruff (D100): OCR/ocr/services/phdc_converter/builder.py#L1
OCR/ocr/services/phdc_converter/builder.py:1:1: D100 Missing docstring in public module
Ruff (D205): OCR/ocr/services/phdc_converter/builder.py#L17
OCR/ocr/services/phdc_converter/builder.py:17:5: D205 1 blank line required between summary line and description
Ruff (D102): OCR/ocr/services/phdc_converter/builder.py#L220
OCR/ocr/services/phdc_converter/builder.py:220:9: D102 Missing docstring in public method
python
ubuntu-latest pipelines will use ubuntu-24.04 soon. For more details, see https://github.com/actions/runner-images/issues/10636
python
The `python-version` input is not set. The version of Python currently in `PATH` will be used.