digitalocean / digitalocean/resource_kit

Confusing documentation of body method for action

Open
#35 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Ruby
Stars
138
Forks
60
PR merge metrics
No merged PRs in 30d

Description

I notices the documentation for how to use the body method of an action had a comment about generating a response body. Looking at the code this method appears to be used to generate the request body.

```
body { |object| DropletMapping.representation_for(:create, object) } # Generate a response body from a passed object
```

Is this comment correct or should it say something more on the lines of `Generate a request body...`

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.