luckyframework / luckyframework/avram
The developer should be guided away from direct use of Avram::DeleteOperation(T), rather than <Model>::DeleteOperation
Nobody has claimed this yet.
- Dominant language
- Crystal
- Stars
- 183
- Forks
- 67
- PR merge metrics
- No merged PRs in 30d
Description
In my naive reading of the documentation, I did not pick up that the developer should not use Avram::DeleteOperation(T) directly, and should instead use <Model>::DeleteOperation. This resulted in attributes and a method not being defined when I expected them to be. A note to this effect should be placed in the API doc for Avram::DeleteOperation(T), and delete operations should be explained in the guides.
Contributor guide
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
Start with the API documentation for Avram::DeleteOperation(T) and the existing guides for delete operations. Add a clear warning to use ::DeleteOperation instead, explain delete operations in the guides, and confirm that both documentation locations cover the difference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- crystal
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100