Skip to content

Commit b3d01c4

Browse files
committed
remove nested layer in docs; resolve docstring format err
1 parent cf1d3ad commit b3d01c4

File tree

2 files changed

+19
-7
lines changed

2 files changed

+19
-7
lines changed

docs/source/api.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,12 @@ SigMF API
77
:template: custom-module-template.rst
88
:recursive:
99

10-
sigmf
10+
sigmf.apps.convert_wav
11+
sigmf.archive
12+
sigmf.archivereader
13+
sigmf.error
14+
sigmf.schema
15+
sigmf.sigmf_hash
16+
sigmf.sigmffile
17+
sigmf.utils
18+
sigmf.validate

sigmf/sigmffile.py

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1000,12 +1000,16 @@ def dtype_info(datatype):
10001000

10011001
def get_dataset_filename_from_metadata(meta_fn, metadata=None):
10021002
"""
1003-
Parse provided metadata and return the expected data filename. In the case of
1004-
a metadata only distribution, or if the file does not exist, this will return
1005-
'None'. The priority for conflicting:
1006-
1. The file named <stem>.SIGMF_DATASET_EXT if it exists
1007-
2. The file in the DATASET_KEY field (Non-Compliant Dataset) if it exists
1008-
3. None (may be a metadata only distribution)
1003+
Parse provided metadata and return the expected data filename.
1004+
1005+
In the case of a metadata-only distribution, or if the file does not exist,
1006+
this will return ``None``.
1007+
1008+
Priority for conflicting datasets:
1009+
1010+
1. Use the file named ``<stem>.SIGMF_DATASET_EXT`` if it exists.
1011+
2. Use the file in the ``DATASET_KEY`` field (non-compliant dataset) if it exists.
1012+
3. Return ``None`` (may be a metadata-only distribution).
10091013
"""
10101014
compliant_filename = get_sigmf_filenames(meta_fn)["data_fn"]
10111015
noncompliant_filename = metadata["global"].get(SigMFFile.DATASET_KEY, None)

0 commit comments

Comments
 (0)