edelpero / lupa / 19992418131

100%

push

github

docs: add comprehensive RDoc documentation

- Add detailed module-level documentation for Lupa with usage examples
- Document all error classes with descriptions and practical examples
- Add extensive RDoc comments to Lupa::Search class including:
  - Class-level documentation with multiple real-world examples
  - Complete parameter types and return values for all methods
  - Exception documentation with @raise tags
  - Usage examples for public and private methods
- Document Lupa::ScopeMethods module with attribute descriptions
- Include examples for basic usage, default scopes, default search
  attributes, search composition, and array searching
- Add @param, @return, @example, and @api tags throughout
- Total additions: 802 lines across 3 files

5 of 5 new or added lines in 2 files covered. (100.0%)

177 of 177 relevant lines covered (100.0%)

36.58 hits per line