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

README/Documentation Updates #39

Closed
4 tasks
cartermak opened this issue Jun 26, 2023 · 2 comments · Fixed by #77
Closed
4 tasks

README/Documentation Updates #39

cartermak opened this issue Jun 26, 2023 · 2 comments · Fixed by #77
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@cartermak
Copy link
Member

cartermak commented Jun 26, 2023

  • Remove any examples that are just copies of help text from the CLI
  • Reconsider how we document specific commands (consider removing the full documentation of the plans/models commands)
  • Consider restructuring some examples into a "Cookbook"
  • Document CLI completion (need compinit in .zshrc)
@cartermak cartermak added the documentation Improvements or additions to documentation label Jun 26, 2023
@cartermak cartermak added this to the v1.2.0 milestone Jun 29, 2023
@cartermak cartermak modified the milestones: v1.2.0, v2 Jul 11, 2023
@cartermak
Copy link
Member Author

Updated thoughts:

  • We should auto-generate CLI documentation. To start, we can do this with typer-cli.
  • We should consider auto-generating full documentation of the API using something like Sphinx. Libraries that seem to have been added to aerie-cli a long time ago but not fully integrated include the furo theme and sphinx-click.
  • Coverage reports can be re-added (with automation, assuming we want them to be used) by importing coverage as a dev dependency and configuring in pyproject.toml:
[tool.coverage.paths]
source = ["src", "*/site-packages"]
tests = ["tests", "*/tests"]

[tool.coverage.run]
branch = true
source = ["aerie_cli", "tests"]

[tool.coverage.report]
show_missing = true
fail_under = 100

@cartermak
Copy link
Member Author

Partially migrated to #76 and will otherwise be closed by #77.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant