14207073031
92%

Ran 01 Apr 2025 10:15PM UTC

Jobs 1

Files 31

Run time 1min

Badge

Embed ▾

Committed 01 Apr 2025 10:12PM UTC coverage: 61.84% (+0.2%) from 61.624%

Build # 14207073031

Build Type

push

github

Committed by

web-flow

Commit Message

Adding initial Sphinx documentation (#16)

* Setting up documentation.

* removed the pip install, as flit is being used.

* removing more pip.

* Fixing the docs coverage.

* Fixing the coverage combine.

* Trying to fix pytests again.

* Fixing conf.py and adding debug for coverage.

* Fixed pyproject and attempted to fix documentation issue.

* Trying to fix coverage errors again.

* Trying to add documentation

* Trying to fix the docs.

* Add docstrings to functions in `cli.py`, `logger.py`, and `strings.py`

* **cli.py**
  - Add docstrings to `add_default_args`, `add_filepath_args`, `add_computing_args`, `add_model_args`, and `add_training_args` functions to describe their purpose and parameters.

* **logger.py**
  - Add docstring to `configure_logger` function to describe its purpose and parameters.
  - Add docstring to `get_logger` function to describe its purpose and return value.

* **strings.py**
  - Add docstring to `replace_keys` function to describe its purpose, parameters, and return value.
  - Add a `Raises` section to the `replace_keys` function docstring to describe potential exceptions.

---------

Signed-off-by: Gal Egozi <8800898+galegozi@users.noreply.github.com>

Run Details

1768 of 2859 relevant lines covered (61.84%)

0.62 hits per line

Uncovered Existing Lines

Lines	Coverage	∆	File
2	97.14	0.0%	../../../../../opt/hostedtoolcache/Python/3.9.21/x64/lib/python3.9/site-packages/yoke/helpers/cli.py
3	75.0	0.0%	../../../../../opt/hostedtoolcache/Python/3.9.21/x64/lib/python3.9/site-packages/yoke/helpers/strings.py
13	0.0	0.0%	../../../../../opt/hostedtoolcache/Python/3.9.21/x64/lib/python3.9/site-packages/yoke/helpers/logger.py

Jobs

ID	Job ID	Ran	Files	Coverage
1	14207073031.1	01 Apr 2025 10:15PM UTC	31	61.84	GitHub Action Run

lanl / Yoke / 14207073031
92%

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Uncovered Existing Lines

Jobs

Source Files on build 14207073031

lanl / Yoke / 14207073031 92%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Uncovered Existing Lines

Jobs

Source Files on build 14207073031

lanl / Yoke / 14207073031
92%

README BADGES
x