Ruby: Fix QLDoc warnings

This commit is contained in:
Harry Maclean
2022-07-29 12:20:32 +12:00
parent f42d33312f
commit 2034498690
2 changed files with 12 additions and 8 deletions

View File

@@ -92,12 +92,12 @@ private class ParsedStringRegExp extends RegExp {
override string getFlags() { none() }
}
/** Provides a class for modelling regular expression interpretations. */
/** Provides a class for modeling regular expression interpretations. */
module RegExpInterpretation {
/**
* Nodes that are not regular expression literals, but are used in places that
* may interpret them regular expressions. Typically these are strings that flow
* to method calls like `RegExp.new`.
* A node that is not a regular expression literal, but is used in places that
* may interpret it as one. Instances of this class are typically strings that
* flow to method calls like `RegExp.new`.
*/
abstract class Range extends DataFlow::Node { }
}

View File

@@ -953,10 +953,14 @@ module ActionDispatch {
private string anyHttpMethod() { result = ["get", "post", "put", "patch", "delete"] }
/**
* The inverse of `pluralize`
* photos => photo
* stories => story
* not_plural => not_plural
* The inverse of `pluralize`. If `input` is a plural word, it returns the
* singular version.
*
* Examples:
*
* - photos -> photo
* - stories -> story
* - not_plural -> not_plural
*/
bindingset[input]
private string singularize(string input) {