Skip to content

Commit

Permalink
typos and clarification on signing commits (#6940)
Browse files Browse the repository at this point in the history
* cosmetic: fix typos
* Add missing piece to the PR template

Signed-off-by: Michael Sorens <msorens@styra.com>
  • Loading branch information
msorens authored Aug 19, 2024
1 parent 10f4d55 commit 07c7bb8
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 14 deletions.
2 changes: 2 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ For more information on contributing to OPA see:
* [Contributing Guide](https://www.openpolicyagent.org/docs/latest/contributing/)
for high-level contributing guidelines and development setup.
(See the [Developer Certificate of Origin](https://www.openpolicyagent.org/docs/latest/contrib-code/#developer-certificate-of-origin)
section for specifics on signing off a commit.)
-->

Expand Down
14 changes: 7 additions & 7 deletions ast/builtins.go
Original file line number Diff line number Diff line change
Expand Up @@ -1181,7 +1181,7 @@ var Split = &Builtin{
types.Named("x", types.S).Description("string that is split"),
types.Named("delimiter", types.S).Description("delimiter used for splitting"),
),
types.Named("ys", types.NewArray(nil, types.S)).Description("splitted parts"),
types.Named("ys", types.NewArray(nil, types.S)).Description("split parts"),
),
Categories: stringsCat,
}
Expand Down Expand Up @@ -1247,7 +1247,7 @@ var Trim = &Builtin{

var TrimLeft = &Builtin{
Name: "trim_left",
Description: "Returns `value` with all leading instances of the `cutset` chartacters removed.",
Description: "Returns `value` with all leading instances of the `cutset` characters removed.",
Decl: types.NewFunction(
types.Args(
types.Named("value", types.S).Description("string to trim"),
Expand All @@ -1273,7 +1273,7 @@ var TrimPrefix = &Builtin{

var TrimRight = &Builtin{
Name: "trim_right",
Description: "Returns `value` with all trailing instances of the `cutset` chartacters removed.",
Description: "Returns `value` with all trailing instances of the `cutset` characters removed.",
Decl: types.NewFunction(
types.Args(
types.Named("value", types.S).Description("string to trim"),
Expand Down Expand Up @@ -1356,7 +1356,7 @@ var RenderTemplate = &Builtin{
// Marked non-deterministic because it relies on RNG internally.
var RandIntn = &Builtin{
Name: "rand.intn",
Description: "Returns a random integer between `0` and `n` (`n` exlusive). If `n` is `0`, then `y` is always `0`. For any given argument pair (`str`, `n`), the output will be consistent throughout a query evaluation.",
Description: "Returns a random integer between `0` and `n` (`n` exclusive). If `n` is `0`, then `y` is always `0`. For any given argument pair (`str`, `n`), the output will be consistent throughout a query evaluation.",
Decl: types.NewFunction(
types.Args(
types.Named("str", types.S),
Expand Down Expand Up @@ -1750,7 +1750,7 @@ var JSONUnmarshal = &Builtin{
types.Args(
types.Named("x", types.S).Description("a JSON string"),
),
types.Named("y", types.A).Description("the term deseralized from `x`"),
types.Named("y", types.A).Description("the term deserialized from `x`"),
),
Categories: encoding,
}
Expand Down Expand Up @@ -1914,7 +1914,7 @@ var YAMLUnmarshal = &Builtin{
types.Args(
types.Named("x", types.S).Description("a YAML string"),
),
types.Named("y", types.A).Description("the term deseralized from `x`"),
types.Named("y", types.A).Description("the term deserialized from `x`"),
),
Categories: encoding,
}
Expand Down Expand Up @@ -1951,7 +1951,7 @@ var HexDecode = &Builtin{
types.Args(
types.Named("x", types.S).Description("a hex-encoded string"),
),
types.Named("y", types.S).Description("deseralized from `x`"),
types.Named("y", types.S).Description("deserialized from `x`"),
),
Categories: encoding,
}
Expand Down
14 changes: 7 additions & 7 deletions builtin_metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -7034,7 +7034,7 @@
"description": "Deserializes the hex-encoded input string.",
"introduced": "v0.25.0-rc2",
"result": {
"description": "deseralized from `x`",
"description": "deserialized from `x`",
"name": "y",
"type": "string"
},
Expand Down Expand Up @@ -11493,7 +11493,7 @@
"description": "Deserializes the input string.",
"introduced": "v0.17.0",
"result": {
"description": "the term deseralized from `x`",
"description": "the term deserialized from `x`",
"name": "y",
"type": "any"
},
Expand Down Expand Up @@ -14993,7 +14993,7 @@
"v0.67.1",
"edge"
],
"description": "Returns a random integer between `0` and `n` (`n` exlusive). If `n` is `0`, then `y` is always `0`. For any given argument pair (`str`, `n`), the output will be consistent throughout a query evaluation.",
"description": "Returns a random integer between `0` and `n` (`n` exclusive). If `n` is `0`, then `y` is always `0`. For any given argument pair (`str`, `n`), the output will be consistent throughout a query evaluation.",
"introduced": "v0.31.0",
"result": {
"description": "random integer in the range `[0, abs(n))`",
Expand Down Expand Up @@ -17307,7 +17307,7 @@
"description": "Split returns an array containing elements of the input string split on a delimiter.",
"introduced": "v0.17.0",
"result": {
"description": "splitted parts",
"description": "split parts",
"name": "ys",
"type": "array[string]"
},
Expand Down Expand Up @@ -19875,7 +19875,7 @@
"v0.67.1",
"edge"
],
"description": "Returns `value` with all leading instances of the `cutset` chartacters removed.",
"description": "Returns `value` with all leading instances of the `cutset` characters removed.",
"introduced": "v0.17.0",
"result": {
"description": "string left-trimmed of `cutset` characters",
Expand Down Expand Up @@ -20135,7 +20135,7 @@
"v0.67.1",
"edge"
],
"description": "Returns `value` with all trailing instances of the `cutset` chartacters removed.",
"description": "Returns `value` with all trailing instances of the `cutset` characters removed.",
"introduced": "v0.17.0",
"result": {
"description": "string right-trimmed of `cutset` characters",
Expand Down Expand Up @@ -22061,7 +22061,7 @@
"description": "Deserializes the input string.",
"introduced": "v0.17.0",
"result": {
"description": "the term deseralized from `x`",
"description": "the term deserialized from `x`",
"name": "y",
"type": "any"
},
Expand Down

0 comments on commit 07c7bb8

Please sign in to comment.