Improve docs #184
Merged
Improve docs #184
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
|
I also changed the "sample" setting to |
core23
requested changes
Jan 8, 2021
README.md
Outdated
| @@ -53,7 +53,9 @@ final class MyService | |||
| public function render() | |||
| { | |||
| // ... | |||
| $this->factory->create(); | |||
| $dompdf = $this->factory->create(); // Returns a `Dompdf\Dompdf` object | |||
There was a problem hiding this comment.
The Returns ... comment seems redundant to me
There was a problem hiding this comment.
Well, to me it wasn't clear what a method called create() could return ;-)
There was a problem hiding this comment.
This is just example code to get started. I would leave out anything special that a normal developer could not figure out itself.
There was a problem hiding this comment.
If it's explained in README anybody can figure it out before installing it. Besides, one additional line here doesn't hurt anybody, and the @var annotation is a really nice solution :-)
|
Thanks @ThomasLandauer |
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.