Skip to content

docs(io): update docstrings

Codecov / codecov/patch succeeded Sep 10, 2024 in 1s

78.86% of diff hit (target 75.94%)

View this Pull Request on Codecov

78.86% of diff hit (target 75.94%)

Annotations

Check warning on line 138 in src/erlab/accessors/kspace.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/accessors/kspace.py#L138

Added line #L138 was not covered by tests

Check warning on line 84 in src/erlab/io/__init__.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/__init__.py#L84

Added line #L84 was not covered by tests

Check warning on line 86 in src/erlab/io/__init__.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/__init__.py#L86

Added line #L86 was not covered by tests

Check warning on line 89 in src/erlab/io/__init__.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/__init__.py#L89

Added line #L89 was not covered by tests

Check warning on line 93 in src/erlab/io/__init__.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/__init__.py#L93

Added line #L93 was not covered by tests

Check warning on line 96 in src/erlab/io/__init__.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/__init__.py#L95-L96

Added lines #L95 - L96 were not covered by tests

Check warning on line 75 in src/erlab/io/dataloader.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/dataloader.py#L74-L75

Added lines #L74 - L75 were not covered by tests

Check warning on line 81 in src/erlab/io/dataloader.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/dataloader.py#L79-L81

Added lines #L79 - L81 were not covered by tests

Check warning on line 729 in src/erlab/io/dataloader.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/dataloader.py#L729

Added line #L729 was not covered by tests

Check warning on line 869 in src/erlab/io/dataloader.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/dataloader.py#L869

Added line #L869 was not covered by tests

Check warning on line 1083 in src/erlab/io/dataloader.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/dataloader.py#L1083

Added line #L1083 was not covered by tests

Check warning on line 1085 in src/erlab/io/dataloader.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/dataloader.py#L1085

Added line #L1085 was not covered by tests

Check warning on line 1288 in src/erlab/io/dataloader.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/dataloader.py#L1288

Added line #L1288 was not covered by tests

Check warning on line 47 in src/erlab/io/igor.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/igor.py#L47

Added line #L47 was not covered by tests

Check warning on line 59 in src/erlab/io/igor.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/igor.py#L59

Added line #L59 was not covered by tests

Check warning on line 70 in src/erlab/io/igor.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/igor.py#L70

Added line #L70 was not covered by tests

Check warning on line 76 in src/erlab/io/igor.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/igor.py#L76

Added line #L76 was not covered by tests

Check warning on line 79 in src/erlab/io/igor.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/igor.py#L79

Added line #L79 was not covered by tests

Check warning on line 106 in src/erlab/io/igor.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/igor.py#L106

Added line #L106 was not covered by tests

Check warning on line 39 in src/erlab/io/plugins/kriss.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/plugins/kriss.py#L39

Added line #L39 was not covered by tests

Check warning on line 103 in src/erlab/io/plugins/maestro.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/plugins/maestro.py#L103

Added line #L103 was not covered by tests

Check warning on line 67 in src/erlab/io/plugins/merlin.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/plugins/merlin.py#L67

Added line #L67 was not covered by tests

Check warning on line 111 in src/erlab/io/plugins/merlin.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/plugins/merlin.py#L111

Added line #L111 was not covered by tests

Check warning on line 257 in src/erlab/io/plugins/ssrl52.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/io/plugins/ssrl52.py#L257

Added line #L257 was not covered by tests

Check warning on line 958 in src/erlab/plotting/annotations.py

See this annotation in the file changed.

@codecov codecov / codecov/patch

src/erlab/plotting/annotations.py#L958

Added line #L958 was not covered by tests