-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ADD README.md and docblock #8
Conversation
I add README.md file and docblocks for classes.
|
||
/** | ||
* Class HashFailedException | ||
* @package Dpc\HashVerifier\Exceptions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this isn't needed. It is understood from the namespace
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok ill remove it
README.md
Outdated
|
||
## History | ||
|
||
TODO: Write history |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
history isn't needed
README.md
Outdated
|
||
## Usage | ||
|
||
TODO: Write usage instructions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you attempt this based on the example I have given? If not I will add it later
.idea/modules.xml
Outdated
@@ -4,6 +4,7 @@ | |||
<modules> | |||
<module fileurl="file://$PROJECT_DIR$/.idea/Authvalidator.iml" filepath="$PROJECT_DIR$/.idea/Authvalidator.iml" /> | |||
<module fileurl="file://$PROJECT_DIR$/.idea/hash-verifier.iml" filepath="$PROJECT_DIR$/.idea/hash-verifier.iml" /> | |||
<module fileurl="file://$PROJECT_DIR$/.idea/hash-verifier.iml" filepath="$PROJECT_DIR$/.idea/hash-verifier.iml" /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you remove this folder from tracking? had added it by mistake
Yes because you have tracked /.idea/* folder ... ;) |
.. and my docblcks :D |
Add more explanations
I add README.md file and docblocks for classes.