Skip to content

Commit

Permalink
Fix typos in README and type hints in imap_data_access.query functi…
Browse files Browse the repository at this point in the history
…on return (#46)

* doc: fix typos in README

* fix: type suggestion

* fix: line endings
  • Loading branch information
mfacchinelli authored Jun 13, 2024
1 parent 6a278fc commit bde27e7
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ section for an example of how to set this up.
This package validates filenames and paths to check they follow our standards, as defined by the filename conventions. There is also a class available for
use by other packages to create filepaths and filenames that follow the IMAP SDC conventions.

To use this class, use `imap_data_access.ScienceFilepath`.
To use this class, use `imap_data_access.ScienceFilePath`.

Usage:

Expand All @@ -170,5 +170,5 @@ Usage:
science_file = imap_data_access.ScienceFilePath("imap_swe_l0_sci_20240101_v001.pkts")
# Filepath = /imap/swe/l0/2024/01/imap_swe_l0_sci_20240101_v001.pkts
filepath = science_file.construct_file_path()
filepath = science_file.construct_path()
```
2 changes: 1 addition & 1 deletion imap_data_access/io.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ def query(
repointing: Optional[int] = None,
version: Optional[str] = None,
extension: Optional[str] = None,
) -> list[str]:
) -> list[dict[str, str]]:
"""Query the data archive for files matching the parameters.
Parameters
Expand Down

0 comments on commit bde27e7

Please sign in to comment.