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.

Sign up for GitHub

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

Jump to bottom

Documentation fixes #1658

Merged
merged 3 commits into from
Jan 12, 2024
Merged

Documentation fixes #1658

merged 3 commits into from
Jan 12, 2024

Conversation

mdahlhausen
Copy link
Collaborator

@mdahlhausen mdahlhausen commented Jan 11, 2024 •
edited
Loading

Pull request overview

Adds descriptions to new modules and provides some minor rubocop fixes

  • Documented new methods using yard syntax
  • Resolved yard documentation errors for new code (ran bundle exec rake doc)
  • Resolved rubocop syntax errors for new code (ran bundle exec rake rubocop)
  • All new and existing tests passes

Review Checklist

This will not be exhaustively relevant to every PR.

  • Perform a code review on GitHub
  • Check rubocop errors
  • Check yard doc errors
  • CI status: all green or justified

@mdahlhausen mdahlhausen merged commit 24a9c23 into master Jan 12, 2024
1 of 2 checks passed
@mdahlhausen mdahlhausen deleted the fix/docs branch January 12, 2024 21:17
@mdahlhausen mdahlhausen changed the title Minor documentation fixes Documentation fixes Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@mdahlhausen