Skip to content

Another documentation pass #77

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

Merged
merged 14 commits into from
Apr 6, 2023
Merged

Another documentation pass #77

merged 14 commits into from
Apr 6, 2023

Conversation

dshemetov
Copy link
Contributor

I figured it would be faster for me to make the changes myself than to make comments in the other PR, so here is a documentation pass.

  • Merged dev into the branch.
  • A number of style consistency fixes.
  • Paid attention to specify whether arguments are vectors where appropriate.
  • Specified optional arguments where appropriate.
  • Added @references tags to various API docs strings.
  • Reworded a number of argument specifications, corrected epirange format specifications for dates vs epiweeks.
  • Fixed as_of, issues, and lags arg strings.

dshemetov and others added 12 commits March 15, 2023 16:06
* Revert back to old `format_list` logic, which was simpler
* Fix `format_item` to not insert extra spaces after some commas, which resulted
  in incorrect API requests.
* Use `vapply` rather than `sapply` in `format_list` to potentially catch weird
  cases and express expectations.
* Add a few formatting tests.
Copy link
Contributor

@brookslogan brookslogan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good in general. I've noted a lot of nit picks which are not blocking but which I think we'd want to address soon (e.g., maybe also in km-edit). I'm not sure I really gave this a good lookover; there are so many endpoints and it's hard to keep paying attention. Probably bad for maintainability. We might want to use some templates or the new support for inline computed strings in roxygen2.

@brookslogan
Copy link
Contributor

Let me know if it's better to just merge & have me PR some changes for the above.

@dshemetov
Copy link
Contributor Author

Thanks for the close look! I'll make the changes you suggest, but yea, probably just start making the changes you want in another branch next time, I don't think we need to discuss the docs too deeply at this point.

@dshemetov dshemetov merged commit 4b7205c into km-edit Apr 6, 2023
@dshemetov dshemetov deleted the ds/docs branch April 6, 2023 21:47
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

Successfully merging this pull request may close these issues.

3 participants