summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKevin Newton <kddnewton@gmail.com>2024-01-17 12:42:44 -0500
committergit <svn-admin@ruby-lang.org>2024-01-17 17:42:50 +0000
commitcd4290910c7f3f63118567101bf6cec4df90361a (patch)
treef88ef1bef773238b9787dca62eb92409b10a2132
parent32cbbfc97d56d9c01677b5411518b52c9404c484 (diff)
[ruby/prism] Wording in node field comments
https://github.com/ruby/prism/commit/c9c913ee99
-rw-r--r--prism/config.yml93
1 files changed, 40 insertions, 53 deletions
diff --git a/prism/config.yml b/prism/config.yml
index 85d0f50103..0bff427bbf 100644
--- a/prism/config.yml
+++ b/prism/config.yml
@@ -476,30 +476,32 @@ nodes:
- name: left
type: node
comment: |
- Represents left side of expression. It includes any kind of node that returns a non-void value.
+ Represents the left side of the expression. It can be any kind of node
+ that represents a non-void expression.
- left and right
- ^^^^
- 1 && 2
- ^
+ left and right
+ ^^^^
+
+ 1 && 2
+ ^
- name: right
type: node
comment: |
- Represents right side of expression. It includes any kind of node that returns non-void value.
- If nothing is given, it will be replaced by MissingNode.
+ Represents the right side of the expression. It can be any kind of
+ node that represents a non-void expression.
- left && right
- ^^^^^
- 1 and 2
- ^
+ left && right
+ ^^^^^
+
+ 1 and 2
+ ^
- name: operator_loc
type: location
comment: |
- The Location of `and` keyword or `&&` operator.
- The only difference between the two is that `&&` has higher precedence than `and`.
+ The location of the `and` keyword or the `&&` operator.
- left and right
- ^^^
+ left and right
+ ^^^
comment: |
Represents the use of the `&&` operator or the `and` keyword.
@@ -570,7 +572,8 @@ nodes:
- name: key
type: node
comment: |
- The key of the association. This can be any node that represents a non-void expression.
+ The key of the association. This can be any node that represents a
+ non-void expression.
{ a: b }
^
@@ -701,8 +704,8 @@ nodes:
comment: |
Represents a block of ruby code.
- [1, 2, 3].each { |i| puts x }
- ^^^^^^^^^^^^^^
+ [1, 2, 3].each { |i| puts x }
+ ^^^^^^^^^^^^^^
- name: BlockParameterNode
fields:
- name: flags
@@ -1214,7 +1217,8 @@ nodes:
- name: name
type: constant
comment: |
- Represents writing to a constant in a context that doesn't have an explicit value.
+ Represents writing to a constant in a context that doesn't have an
+ explicit value.
Foo, Bar = baz
^^^ ^^^
@@ -1845,19 +1849,6 @@ nodes:
- name: flags
type: flags
kind: IntegerBaseFlags
- comment: |
- Represents flag indicating the base of the integer
-
- 10 base decimal, value 10
- 0d10 base decimal, value 10
- 0b10 base binary, value 2
- 0o10 base octal, value 8
- 010 base octal, value 8
- 0x10 base hexidecimal, value 16
-
- A 0 prefix indicates the number has a different base.
- The d, b, o, and x prefixes indicate the base. If one of those
- four letters is omitted, the base is assumed to be octal.
comment: |
Represents an integer number literal.
@@ -2295,30 +2286,32 @@ nodes:
- name: left
type: node
comment: |
- Represents left side of expression. It includes any kind of node that returns a non-void value.
+ Represents the left side of the expression. It can be any kind of node
+ that represents a non-void expression.
- left or right
- ^^^^
- 1 || 2
- ^
+ left or right
+ ^^^^
+
+ 1 || 2
+ ^
- name: right
type: node
comment: |
- Represents right side of expression. It includes any kind of node that returns a non-void value.
- If nothing is given, it will be replaced by MissingNode.
+ Represents the right side of the expression. It can be any kind of
+ node that represents a non-void expression.
- left || right
- ^^^^^
- 1 or 2
- ^
+ left || right
+ ^^^^^
+
+ 1 or 2
+ ^
- name: operator_loc
type: location
comment: |
- The Location of `or` keyword or `||` operator.
- The only difference between the two is that `||` has higher precedence than `or`.
+ The location of the `or` keyword or the `||` operator.
- left or right
- ^^
+ left or right
+ ^^
comment: |
Represents the use of the `||` operator or the `or` keyword.
@@ -2434,12 +2427,6 @@ nodes:
- name: flags
type: flags
kind: RangeFlags
- comment: |
- A flag indicating whether the range excludes the end value.
-
- 1..3 # includes 3
-
- 1...3 # excludes 3
- name: left
type: node?
comment: |