Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Api documentation #199

Open
1 of 7 tasks
LecrisUT opened this issue Aug 8, 2023 · 0 comments
Open
1 of 7 tasks

Api documentation #199

LecrisUT opened this issue Aug 8, 2023 · 0 comments

Comments

@LecrisUT
Copy link
Contributor

LecrisUT commented Aug 8, 2023

I am planning to use the fmf framework for an academic project of mine, but I find the documentation should be improved:

  • type-hints for the api classes
  • equivalent api for the cli commands
  • document how to read, access the data from an fmf tree
  • document how to write an fmf tree
  • document how to define/use Contexts
  • document the source of the Context data (from the tmt tree and from built-ins)
  • document extension apis. Currently there are none afaik, but there could be the plans for them. E.g. compatibility and extensions with linters/json-schema, or apis to define different abstract sources like archived sources
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant