luckyframework / luckyframework/avram

Avram::DeleteOperation(T) class doc doesn't document constructors

Open
#633 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Crystal
Stars
183
Forks
67
PR merge metrics
No merged PRs in 30d

Description

The class doc for `Avram::DeleteOperation` doesn't document its constructors. It should give:

```
#new(record : T, params : Avram::Paramable)
#new(record : T)
```

Contributor guide

Open the contributing guide

Research direction

Start at the Avram::DeleteOperation class documentation and inspect how its constructors are currently described. Compare the documentation with the two constructor signatures named in the issue, then verify that both overloads are shown in the generated class documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
crystal
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.