Skip to content
This repository has been archived by the owner on Jul 19, 2023. It is now read-only.

improvement idea - report handled formats #10

Open
rob-metalinkage opened this issue Apr 5, 2016 · 0 comments
Open

improvement idea - report handled formats #10

rob-metalinkage opened this issue Apr 5, 2016 · 0 comments

Comments

@rob-metalinkage
Copy link

trying to find what formats are handled - and in the context of an extensible module - hers and improvement idea:

provide a means for the handlers to report what formats they support and some way to provide user documentation. If the handlers do this and the module provides the API to expose it to user apps then reusable documentation can be bundled with any third party extensions.

Docs might be scoped to multiple levels:

  1. packaging (i.e. requirements for a zip file - such as internal structure assumptions
  2. file format - extension, encodings etc
  3. fields
  4. process
  5. outputs (user visible)

intermediate handlers the user doesnt directly interact with might only populate process documentation to record what is being done.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants