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

Document and run benchmarking #1017

Closed
9 tasks
utkarsharma2 opened this issue Oct 7, 2022 · 2 comments
Closed
9 tasks

Document and run benchmarking #1017

utkarsharma2 opened this issue Oct 7, 2022 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation priority/low Low priority product/python-sdk Label describing products
Milestone

Comments

@utkarsharma2
Copy link
Collaborator

Please describe the feature you'd like to see

  1. Document the config.json
  2. All the esoteric features
  3. @pankajastro should be able to run benchmarking without any support

Describe the solution you'd like
A clear and concise description of what you want to happen, if possible with code examples.

Are there any alternatives to this feature?
Is there another way we could solve this problem or enable this use-case?

Additional context
Add any other context about the feature request here.

Acceptance Criteria

  • All checks and tests in the CI should pass
  • Unit tests (90% code coverage or more, once available)
  • Integration tests (if the feature relates to a new database or external service)
  • Example DAG
  • Docstrings in reStructuredText for each of methods, classes, functions and module-level attributes (including Example DAG on how it should be used)
  • Exception handling in case of errors
  • Logging (are we exposing useful information to the user? e.g. source and destination)
  • Improve the documentation (README, Sphinx, and any other relevant)
  • How to use Guide for the feature (example)
@utkarsharma2 utkarsharma2 added the feature New feature or request label Oct 7, 2022
@utkarsharma2 utkarsharma2 added this to the 1.2.0 milestone Oct 7, 2022
@phanikumv phanikumv added documentation Improvements or additions to documentation priority/low Low priority labels Oct 10, 2022
@pankajastro
Copy link
Contributor

@pankajastro pankajastro added product/python-sdk Label describing products and removed feature New feature or request labels Oct 19, 2022
@sunank200
Copy link
Contributor

Closing this as documentation is completed from @pankajastro .

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 priority/low Low priority product/python-sdk Label describing products
Projects
None yet
Development

No branches or pull requests

4 participants