Update README.md docs for Cronitor::Monitor.put #26
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: