Skip to content

Conversation

@jpignata
Copy link
Contributor

Directly commits content from cop class documentation that at least
provides an example or a description that isn't just a restatement
of the check name or description.

The motivation behind this change is to ensure that the content being
exposed through the Code Climate service is useful and gives the user
more details on how to resolve the issue being reported rather than
restating a portion of the description. By directly committing the
content this allows us to start supplementing the content from other
sources such as the Ruby styleguide and our own original content.

@codeclimate/review

@wfleming
Copy link
Contributor

Is this effectively just the results of the scrape job committed? I liked having it be an automatic step, since having this committed makes me worry it's going to get outdated & not updated. What advantages does this give us?

@jpignata
Copy link
Contributor Author

@wfleming This is the results of a subset of the scrape job committed. The intent of this change is to eliminate content that isn't helpful to the end user. The class comments in cops are often thorough descriptions of the check with examples but sometimes are just summaries of the issue description. Our goal is to reduce the amount of exposed content that doesn't provide much value to the end user. By directly committed these contents, it gives us a base on which we can expand the content to be more valuable by supplementing it with other secondary sources and writing our own original content.

@jpignata jpignata force-pushed the jp/prune-content branch 3 times, most recently from c4982c7 to 0129f40 Compare February 21, 2016 17:16
Directly commits content from cop class documentation that at least
provides an example or a description that isn't just a restatement
of the check name or description.

The motivation behind this change is to ensure that the content being
exposed through the Code Climate service is useful and gives the user
more details on how to resolve the issue being reported rather than
restating a portion of the description. By directly committing the
content this allows us to start supplementing the content from other
sources such as the Ruby styleguide and our own original content.

* Stop scraping content during the Docker image build
* Scrape documentation from the current version of RuboCop
* Modify regular expression to better target class documentation
* Replace good/bad rdoc tokens with comments
jpignata added a commit that referenced this pull request Feb 22, 2016
@jpignata jpignata merged commit f324539 into master Feb 22, 2016
@jpignata jpignata deleted the jp/prune-content branch February 22, 2016 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants