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

Update README.md docs for Cronitor::Monitor.put #26

Merged
merged 2 commits into from
Jan 17, 2024

Conversation

nohat
Copy link
Contributor

@nohat nohat commented Nov 12, 2023

This PR updates the README.md of the Cronitor-Ruby gem, specifically revising the documentation for the Cronitor::Monitor.put method to address inaccuracies and enhance clarity.

The primary issue in the existing documentation is the incorrect usage example. It suggests that the Monitor.put method directly accepts an array of monitors, which contrasts with the actual requirement of passing these monitors within an options hash. Additionally, the current documentation lacks detail on method parameters and error handling.

This update includes:

  1. A corrected usage example aligning with the method's implementation.
  2. A concise overview of parameters and options.
  3. A brief note on error handling associated with the method.

Copy link
Collaborator

@jeffbyrnes jeffbyrnes left a comment

Choose a reason for hiding this comment

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

@nohat thanks so much for this! Left one request to undo some of your changes, but the additions you’ve made are fantastic.

README.md Outdated Show resolved Hide resolved
@aflanagan aflanagan merged commit bbc8817 into cronitorio:master Jan 17, 2024
4 checks passed
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