Skip to content

Document procedure for new Reader type creation #4

@pmslavin

Description

@pmslavin

Following the merge of #3, modular support for adding new Reader subtypes will be available.

This issue is to provide documentation oriented towards developers which describes the process of implementing a new concrete Reader type. Docstrings in the abstract base class give an overview of the roles of the required methods, but additional detail about:

  • Argument and return types
  • Exceptions that may be raised
  • Resource-acquisition behaviour

...amongst other issues should be provided.

This should be accompanied by one or more examples of creating a Reader, testing it, and integrating it with any build, documentation, and CI systems that are present.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions