Polish up Req.Request docs #366
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
whatyouhide
commented
Jun 1, 2024
| @@ -122,45 +122,51 @@ defmodule Req.Request do | |||
| Nothing is actually executed until we run the pipeline with `Req.Request.run_request/1`. | |||
| ### Request steps | |||
| ### Request Steps | |||
There was a problem hiding this comment.
Consistent title casing.
| @@ -575,14 +590,15 @@ defmodule Req.Request do | |||
| iex> Req.Request.update_private(req, :b, 11, & &1 + 1).private | |||
| %{a: 1, b: 11} | |||
| """ | |||
| @spec update_private(t(), key :: atom(), default :: term(), (atom() -> term())) :: t() | |||
| @spec update_private(t(), key :: atom(), default :: term(), (term() -> term())) :: t() | |||
There was a problem hiding this comment.
This was an error I think.
| @@ -632,6 +653,7 @@ defmodule Req.Request do | |||
| inspect: &IO.inspect/1 | |||
| ) | |||
| """ | |||
| @spec append_request_steps(t(), keyword(fun())) :: t() | |||
There was a problem hiding this comment.
I think we might want to make the request_step and friends public types, as they are documented in the module doc anyway. Thoughts?
There was a problem hiding this comment.
Yeah we can add the type and use it in specs. I’d hold off on speccing request.request_steps and friends though, I want to have an option to add metadata around steps in the future if I need to.
wojtekmach
approved these changes
Jun 1, 2024
| @@ -556,6 +570,7 @@ defmodule Req.Request do | |||
| @doc """ | |||
| Gets the value for a specific private `key`. | |||
| """ | |||
| @spec get_private(t(), atom(), default) :: term() | default when default: var | |||
There was a problem hiding this comment.
As far as I always understood it sort of means the same value as whatever you passed in as the arg of the function.
|
Thank you! |
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.