Update documentation #2
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
utkarsh2102
commented
Jun 15, 2020
|
I'll review this later. You can disable "Squash merging" in the repo settings if you want :) |
There was a problem hiding this comment.
These docs are super-neat @utkarsh2102. Nice job 👍. I added some comments, but really minor.
terceiro
reviewed
Jun 16, 2020
Co-authored-by: David Rodríguez <deivid.rodriguez@riseup.net>
This basically does the 3 following things: - Adds `# :nodoc:` for the three modules that doesn't need any documentation. Thanks to Antonio for this suggestion. - It replaces the link to `cop.rb` file as a permalink so it doesn't get broken over time. Thanks to David for this suggestion. - Paraphrases a line in README.md so as to *not* use the word "cop" as readers might not be familiar with the term. Signed-off-by: Utkarsh Gupta <utkarsh@debian.org>
|
Thanks, @deivid-rodriguez and @terceiro! |
deivid-rodriguez
approved these changes
Jun 16, 2020
|
Thanks, both. |
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.
Hi,
This PR documents the entire source code and also adds the
docs/directory.For a visual representation of the change, you can check the documentation branch.
The source code is now 100% documented:
Please don't squash the commits as they each represent a separate change.