Skip to content

Commit f116b48

Browse files
Apply suggestions from code review
Co-authored-by: apradoada <110429145+apradoada@users.noreply.github.com>
1 parent 7a466fe commit f116b48

File tree

3 files changed

+4
-5
lines changed

3 files changed

+4
-5
lines changed

ada-project-docs/wave_01.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ Use the tests in `tests/test_wave_01.py` to guide your implementation.
6767
- Pay attention to the exact shape of the expected JSON. Double-check nested data structures and the names of the keys for any misspellings.
6868
- That said, remember that dictionaries do not have an implied order. This is still true in JSON with objects. When you make Postman requests, the order of the key/value pairings within the response JSON object does not need to match the order specified in this document. (The term "object" in JSON is analogous to "dictionary" in Python.)
6969
- Notice that the details for a Task in the response is shared across all the endpoints that return Task details. Rather than repeating the same literal `dict` structure in each response, we should create a helper method that returns the `dict` structure for a Task, and use it in each relevant endpoint. This will ensure that all our responses are consistent.
70-
- Retrieving a model by its ID is a common operation. We should create a route helper method that can retrieve a model by its ID, and use it in relevant routes.
70+
- We should remember that retrieving a model by its ID is a common operation. We should consider creating a route helper method that can retrieve a model by its ID, and use it in all applicable routes.
71+
- This method could start out only working for Task models. But, knowing that we'll be working with Goal models later on, it might be worth generalizing this method to work with any model.
7172

7273
### CLI
7374

@@ -156,8 +157,6 @@ As a client, I want to be able to make a `GET` request to `/tasks/1` when there
156157
}
157158
```
158159

159-
We should remember that retrieving a model by its ID is a common operation. We should consider creating a route helper method that can retrieve a model by its ID, and use it in this route.
160-
- This method could start out only working for Task models. But, knowing that we'll be working with Goal models later on, it might be worth generalizing this method to work with any model.
161160

162161
#### Update Task
163162

ada-project-docs/wave_03.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Our task list API allows users to meaningfully use the task resource. Users want to be able to mark a task as "complete" or "incomplete."
66

7-
We want to design our API so that it stores a task's `completed_at` date as a datetime value in our database. In this scenario, our API does _not_ give users the `completed_at` date – it only gives the information if `is_complete` is `true` or `false`.
7+
We want to design our API so that it stores a task's `completed_at` date as a datetime value in our database. In this scenario, our API does _not_ give users the `completed_at` date – it only indicates whether `is_complete` is `true` or `false`.
88

99
A task's `is_complete` is:
1010
- `true` when there is a datetime for the task's `completed_at` value.

ada-project-docs/wave_05.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Goal
44

55
Our task list API should be able to work with an entity called `Goal`.
6-
- `Goal`s are entities that describe a task a user wants to complete.
6+
- `Goal`s are entities that describe a set of tasks a user wants to complete.
77
- They contain a title to name the goal.
88

99
Our plan for this wave is to be able to create, read, update, and delete different `Goal`s. We will create RESTful routes for these different operations.

0 commit comments

Comments
 (0)