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 #22

Open
mikeroswell opened this issue Oct 28, 2022 · 0 comments
Open

API documentation #22

mikeroswell opened this issue Oct 28, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation
Projects

Comments

@mikeroswell
Copy link
Collaborator

I think this may be redundant with an existing issue or to-do in tasks.

Update API documentation in "main.py".

  • Filter function should be clearly documented at the top (and vs. or, etc).
  • current filter documentation for period_start_date and period_end_date a bit confusing although not terribly, each one can only take a date range but each works independently on the period start or end as expected. Documentation should just be clear about what the date range pertains to (e.g. any start date falling within /).
@mikeroswell mikeroswell added the documentation Improvements or additions to documentation label Oct 28, 2022
@mikeroswell mikeroswell self-assigned this Oct 28, 2022
@stevencarlislewalker stevencarlislewalker added this to To do in Tasks via automation Oct 30, 2022
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
Tasks
  
To do
Development

No branches or pull requests

1 participant