Skip to content
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.

Sign up for GitHub

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

Check all Ruby blocks in documentation specs #1669

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Check all Ruby blocks in documentation specs #1669

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
14b061d
Check all Ruby blocks in documentation specs
mvz Sep 12, 2022
e1a693d
Correct code block annotations
mvz Sep 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ UtilityFunction:

For a basic overview, run

```ruby
```bash
reek --help
```

Expand Down
2 changes: 1 addition & 1 deletion docs/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ string -- 2 warnings:
Of course, directory specific configuration and excluded paths are supported as
well:

```
```ruby
config_hash = {
'IrresponsibleModule' => { 'enabled' => false }
'spec/samples/three_clean_files/' =>
Expand Down
2 changes: 1 addition & 1 deletion spec/quality/documentation_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
blocks.each do |block|
# Only consider code blocks with language 'ruby'.
next unless code_types.include?(block.type)
next unless block.attr['class'] == 'language-ruby'
next unless block.attr['class']&.downcase == 'language-ruby'

it "has a valid sample at #{block.options[:location] + 1}" do
code = block.value.strip
Expand Down
Loading