Create automatic documentation based on the cop's descriptions #51
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
MassimilianoLattanzio
added
the
documentation
MassimilianoLattanzio
force-pushed
the
ml/documentation
branch
2 times, most recently
from
861a855
to
47262be
Compare
MassimilianoLattanzio
requested review from
piyushswain,
DanielePalombo and
abhishekgupta5
MassimilianoLattanzio
changed the title
There was a problem hiding this comment.
I am finding this PR hard to review -
- Seems like the PR is doing much more what the title of the PR states
- In case, it's doing other stuff, can we mention it in the root comment of the PR as bullet points?
- Some commit messages are not stating why the change is needed / have been added
MassimilianoLattanzio
force-pushed
the
ml/documentation
branch
from
ff2678c
to
c7df15d
Compare
MassimilianoLattanzio
force-pushed
the
ml/documentation
branch
2 times, most recently
from
6737850
to
cae89f6
Compare
Import docs generator rake task from Shopify/rubocop-sorbet@76e7634. This allow us to create docs based on the cop's description.
Some cop descriptions still need to be written, and others don't have relatively bad/good examples. So we updated all descriptions and regenerated the docs.
In this way a documentation link will be shown in the Rubygems page.
MassimilianoLattanzio
force-pushed
the
ml/documentation
branch
3 times, most recently
from
e5afd40
to
767b90e
Compare
I've updated the PR with your suggestion. Let me know if now everything is clear. |
| @@ -20,6 +20,7 @@ Gem::Specification.new do |spec| | |||
| spec.metadata['homepage_uri'] = spec.homepage | |||
| spec.metadata['source_code_uri'] = 'https://www.github.com/solidusio/rubocop-solidus' | |||
| spec.metadata['changelog_uri'] = 'https://www.github.com/solidusio/rubocop-solidus' | |||
| spec.metadata['documentation_uri'] = 'https://www.github.com/solidusio/rubocop-solidus/blob/master/docs/cops.md' | |||
abhishekgupta5
approved these changes
Aug 4, 2023
| - name: Lint files | ||
| run: bundle exec rake rubocop | ||
| - name: Run tests | ||
| run: bundle exec rake spec |
There was a problem hiding this comment.
Just to confirm, is this same as - bundle exec rspec spec?
There was a problem hiding this comment.
Yes!
Lines 13 to 15 in c62eb78
After adding the documentation uri to the gemspec we found a typo in the changelog uri too, so this commit fixes the typo.
When we run rubocop, it will raise a tip regaring suggested exentions. Those extensions are not useful for us, so we disabled the tip. Result after running rubocop: Tip: Based on detected gems, the following RuboCop extension libraries might be helpful: * rubocop-rake (https://rubygems.org/gems/rubocop-rake) * rubocop-rspec (https://rubygems.org/gems/rubocop-rspec) You can opt out of this message by adding the following to your config (see https://docs.rubocop.org/rubocop/extensions.html#extension-suggestions for more options): AllCops: SuggestExtensions: false
This commit contains some improvements for the CI: - Renamed from `Tests` to `CI` because it doesn't run only tests. - Removed `bundle install` step because it's already done in `Setup`. - Created single steps for each rake task. Especially the last point is useful because by separating the step/task, we can easily find and fix which task is failing (if any) and fix it.
This commit contains an improvement on the README readability. Previously, all sections of the README had the same importance. Now we created 4 main sections (Getting started, Documentation, Contributing and License) and moved all other sub-sections under the right top-level section.
MassimilianoLattanzio
force-pushed
the
ml/documentation
branch
from
767b90e
to
55a9f17
Compare
Merged
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.
This PR adds the ability to create docs based on the cop's description directly.
To create new docs, run the
bundle exec raketask, automatically creating all the relative files and checking if the provided examples contain any ruby parsing error.This PR also contains some improvements, not strictly related to the PR topic: