Misc Cleanup of documentation and Build #115
Closed
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
- CHANGED: made rubocop optional - CHANGED: have links in markdown files work for Github and YARD - CHANGED: Minitest::Unit::TestCase -> Minitest::Test - FIXED: Typo in docs for Domain#new - FIXED: dead publicsuffix/format link
|
Hi @gam3, I appreciate the cleanup. However, the patch contains several changes, and I'm not inclined to merge some of them. Specifically, I don't want to monkey path Yard to support Markdown. Moreover, I'd avoid changing the gemspec. Can you please provide a patch with only the documentation updates? Also, I don't think I agree to make Rubocop optional. What is the reason about it? |
|
I will break this into a few separate pull requests. I made Rubocop optional because it really only needs to be run by developers. There is no reason to require the rubocop gem to be installed just to install the publicsuffix gem. |
|
I merged 1f1b03b |
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.
I did some misc cleanup of the documentation. Fixed the README file so that it works for YARD and Github (there must be a better way though). And updated the minitest class names.