Refine docs in Plug.Debugger #164
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
| @@ -244,6 +271,7 @@ defmodule Plug.Debugger do | |||
|
|
|||
| @radius 5 | |||
|
|
|||
| @doc false | |||
| def get_snippet(file, line) do | |||
There was a problem hiding this comment.
This could be defp then, no? :)
- Added `@doc false` to the `template` function (generated by EEx) and to the `get_snippet` function. These functions had no description nor comments. - Added examples on how to use `Plug.Debugger.wrap/3`, both in the module's description and in `wrap/3`'s description. - Other minor formatting changes.
|
Changed both definitions to |
|
It had no documentation, so they should not be using it. :) 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.
@doc falseto thetemplatefunction (generated by EEx) and to theget_snippetfunction. These functions had no description nor comments.Plug.Debugger.wrap/3, both in the module's description and inwrap/3's description.