Add Workflow associations and remove Task #22
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
.activites, .assignee, .notes, .person
| @@ -56,7 +56,7 @@ defmodule PcoApi.People.Workflow.Card.Activity do | |||
|
|
|||
| ## Example: | |||
|
|
|||
| iex> %PcoApi.Record{type: "WorkflowCard", id: 1, links: %{"self" => "http://example.com"}} |> Address.get(2) | |||
| iex> %PcoApi.Record{type: "WorkflowCard", id: 1, links: %{"self" => "http://example.com"}} |> Note.get(2) | |||
There was a problem hiding this comment.
Shouldn't this be Activity.get(2)?
| @@ -56,7 +56,7 @@ defmodule PcoApi.People.Workflow.Card.Activity do | |||
|
|
|||
| ## Example: | |||
|
|
|||
| iex> %PcoApi.Record{type: "WorkflowCard", id: 1, links: %{"self" => "http://example.com"}} |> Address.get(2) | |||
| iex> %PcoApi.Record{type: "WorkflowCard", id: 1, links: %{"self" => "http://example.com"}} |> Activity.get(2) | |||
There was a problem hiding this comment.
Let's be explicit about the module name in the docs. So Activity would become Workflow.Card.Activity.
There was a problem hiding this comment.
Ah, yah good idea.
There was a problem hiding this comment.
Not PcoApi.People.Workflow.Card.Activity?
|
Just a suggestion for inline docs naming as we might eventually have a naming collision. Other than that, 👍. Awesome work! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.