Skip to content

Commit 2034498

Browse files
committed
Ruby: Fix QLDoc warnings
1 parent f42d333 commit 2034498

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

ruby/ql/lib/codeql/ruby/Regexp.qll

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,12 +92,12 @@ private class ParsedStringRegExp extends RegExp {
9292
override string getFlags() { none() }
9393
}
9494

95-
/** Provides a class for modelling regular expression interpretations. */
95+
/** Provides a class for modeling regular expression interpretations. */
9696
module RegExpInterpretation {
9797
/**
98-
* Nodes that are not regular expression literals, but are used in places that
99-
* may interpret them regular expressions. Typically these are strings that flow
100-
* to method calls like `RegExp.new`.
98+
* A node that is not a regular expression literal, but is used in places that
99+
* may interpret it as one. Instances of this class are typically strings that
100+
* flow to method calls like `RegExp.new`.
101101
*/
102102
abstract class Range extends DataFlow::Node { }
103103
}

ruby/ql/lib/codeql/ruby/frameworks/ActionDispatch.qll

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -953,10 +953,14 @@ module ActionDispatch {
953953
private string anyHttpMethod() { result = ["get", "post", "put", "patch", "delete"] }
954954

955955
/**
956-
* The inverse of `pluralize`
957-
* photos => photo
958-
* stories => story
959-
* not_plural => not_plural
956+
* The inverse of `pluralize`. If `input` is a plural word, it returns the
957+
* singular version.
958+
*
959+
* Examples:
960+
*
961+
* - photos -> photo
962+
* - stories -> story
963+
* - not_plural -> not_plural
960964
*/
961965
bindingset[input]
962966
private string singularize(string input) {

0 commit comments

Comments
 (0)