Skip to content

Improve custom input reader docs #647

@hombit

Description

@hombit
  1. It looks like an example at the "Catalog Import Arguments" is outdated and doesn't have the read_columns argument: https://hats-import.readthedocs.io/en/latest/catalogs/arguments.html#how-to-read-them
  2. It also links this API docs page which doesn't have a lot of information: https://hats-import.readthedocs.io/en/latest/reference/api/hats_import.catalog.file_readers.InputReader.html#hats_import.catalog.file_readers.InputReader. Let's change it to https://hats-import.readthedocs.io/en/latest/reference/file_readers.html?
  3. I propose to move the example to the "File Readers" page and maybe extend it by showing how to use read_columns to speed up the mapping stage.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions