crisp-im / crisp-im/ruby-crisp-api
Documentation for usage seems a bit off for some of the methods
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 17
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
Here is an example. Shown input is an array but sending an array in throws errors. This was very confusing and took me a while to figure out. Had to compare what Postman was doing in order to figure out this was not the right way sending in data.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files or tests are named. Start by locating the usage documentation for the methods whose examples show an array input, then compare the documented request format with the behavior described and the Postman request. Done means the examples accurately show the accepted way to send the data.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100