Skip to content

Commit 315004e

Browse files
authored
Fix YARD documentation warnings (#21)
Additionally: - Use https where possible - Remove 404 links (`awesome_bot`) - Fix typos (`codespell`)
1 parent d28e804 commit 315004e

19 files changed

Lines changed: 39 additions & 35 deletions

File tree

CHANGELOG.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,15 @@
22

33
All notable changes to this project will be documented in this file.
44

5-
The format is based on [Keep a Changelog](http://keepachangelog.com/) and this
6-
project adheres to [Semantic Versioning](http://semver.org/)
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/) and this
6+
project adheres to [Semantic Versioning](https://semver.org/)
7+
8+
## Unreleased
9+
10+
### Fixed
11+
* Fix YARD documentation warnings:
12+
- Remove curly braces from `@see` tags (causes rendering issues)
13+
- Use fully-qualified constant names for `ACL#find_by_role` references (`Eaco::ACL#find_by_role`)
714

815
## 1.1.1 - 2017-03-08
916

features/support/env.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@
1313

1414
##
1515
# Create a whole new world.
16-
# @see {World}
16+
# @see World
1717
# @!method World
1818
World do
1919
Eaco::Cucumber::World.new
2020
end
2121

2222
##
2323
# Recreate the schema before each feature, to start fresh.
24-
# @see {ActiveRecord.define_schema!}
24+
# @see ActiveRecord.define_schema!
2525
# @!method Before
2626
Before do
2727
Eaco::Cucumber::ActiveRecord.define_schema!

lib/eaco.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ def self.parse_rules!(rules)
6060
end
6161

6262
##
63-
# Evaluates the given authorization rules +source+, orignally found on
63+
# Evaluates the given authorization rules +source+, originally found on
6464
# +path+.
6565
#
6666
# @param source [String] {DSL} source code

lib/eaco/adapters.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
module Eaco
22

3-
# Persistance adapters for ACL objects and authorized collections extractor
3+
# Persistence adapters for ACL objects and authorized collections extractor
44
# strategies.
55
#
66
# @see ActiveRecord

lib/eaco/adapters/active_record.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ def self.strategies
2121
end
2222

2323
##
24-
# Checks whether the model's data structure fits the ACL persistance
24+
# Checks whether the model's data structure fits the ACL persistence
2525
# requirements.
2626
#
2727
# @param base [Class] your application's model

lib/eaco/adapters/active_record/compatibility/v40.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ module V40
1010
##
1111
#
1212
# Sets up the OID Type Map, reloads it, hacks native database types,
13-
# and makes jsonb mimick itself as a json - for the rest of the AR
13+
# and makes jsonb mimic itself as a json - for the rest of the AR
1414
# machinery to work intact.
1515
#
1616
# @param base [Class] the +ActiveRecord+ model to mangle

lib/eaco/adapters/active_record/compatibility/v51.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ class Compatibility
1111
#
1212
# @see Scoped
1313
#
14-
# Sanitize has dissapeared in favour of quote.
14+
# Sanitize has disappeared in favour of quote.
1515
#
1616
# @see Sanitized
1717
#

lib/eaco/adapters/active_record/compatibility/v52.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ class Compatibility
1111
#
1212
# @see Scoped
1313
#
14-
# Sanitize has dissapeared in favour of quote.
14+
# Sanitize has disappeared in favour of quote.
1515
#
1616
# @see Sanitized
1717
#

lib/eaco/adapters/active_record/compatibility/v60.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ class Compatibility
1111
#
1212
# @see Scoped
1313
#
14-
# Sanitize has dissapeared in favour of quote.
14+
# Sanitize has disappeared in favour of quote.
1515
#
1616
# @see Sanitized
1717
#

lib/eaco/adapters/active_record/compatibility/v61.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ class Compatibility
1111
#
1212
# @see Scoped
1313
#
14-
# Sanitize has dissapeared in favour of quote.
14+
# Sanitize has disappeared in favour of quote.
1515
#
1616
# @see Sanitized
1717
#

0 commit comments

Comments
 (0)