Skip to content

Commit 493d2c2

Browse files
authored
Fix parameters in Java comments (#2394)
Updates the parameters to match the form used for the other tracks. Fixes exercism/exercism#6776.
1 parent 49aeb48 commit 493d2c2

10 files changed

Lines changed: 12 additions & 12 deletions

File tree

analyzer-comments/java/general/constructor_too_long.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# constructor too long
22

3-
Consider breaking down the following constructor(s) into calls to other semantically meaningful methods: `%<constructorNames>s`
3+
Consider breaking down the following constructor(s) into calls to other semantically meaningful methods: `%{constructorNames}`
44

55
The constructor has more lines of code than this exercise generally requires.
66
This might be acceptable, but it could be an indication that the constructor is doing too much work directly and should be delegating some of that work to other methods.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Exemplar
22

3-
🎉 Your solution to %<exerciseName>s is exemplar, congratulations!
3+
🎉 Your solution to %{exerciseName} is exemplar, congratulations!
44
It is exactly what we think is the most idiomatic implementation of the tasks at hand.
55
Rejoice!

analyzer-comments/java/general/file_not_found.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
The expected solution file was not found.
44

5-
Upload the solution file `./src/main/java/%<solutionFile>s`:
5+
Upload the solution file `./src/main/java/%{solutionFile}`:
66

77
```
8-
$ exercism submit ./src/main/java/%<solutionFile>s
8+
$ exercism submit ./src/main/java/%{solutionFile}
99
```
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# method too long
22

3-
Consider breaking down the following method(s) into calls to other semantically meaningful methods: `%<methodNames>s`
3+
Consider breaking down the following method(s) into calls to other semantically meaningful methods: `%{methodNames}`
44

55
The method has more lines of code than this exercise generally requires.
66
This might be acceptable, but it could be an indication that the method is doing too much work directly and should be delegating some of that work to other methods.
77
Try to keep everything inside a method at one level of abstraction.
8-
For example, iterating through the elements of a loop could be in one method while manipulating each individual element could be in another.
8+
For example, iterating through the elements of a loop could be in one method while manipulating each individual element could be in another.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Reuse code
22

3-
The `%<callingMethod>s` method should reuse the logic implemented in `%<methodToCall>s`.
3+
The `%{callingMethod}` method should reuse the logic implemented in `%{methodToCall}`.
44
Reusing existing methods can help make code easier to maintain.

analyzer-comments/java/general/use_proper_class_name.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
The class name should match the file name.
44

5-
Rename the class to `%<className>s`.
5+
Rename the class to `%{className}`.

analyzer-comments/java/general/use_proper_method_name.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The method name should match exactly what was used in the tests.
44

5-
Rename the method to `%<methodName>s`.
5+
Rename the method to `%{methodName}`.
66

77
**NOTE**: Don't modify the tests to match a different method name.
88
In general, try to only add additional tests (if desired).
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# use substring method
22

3-
Consider using the [substring][substring-method] method in `%<inMethod>s` to solve this exercise.
3+
Consider using the [substring][substring-method] method in `%{inMethod}` to solve this exercise.
44

55
[substring-method]: https://docs.oracle.com/javase/8/docs/api/java/lang/String.html#substring-int-int-
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# use ternary operators
22

3-
As the goal of this exercise is to learn about ternary operators consider using them in `%<inMethod>s` to solve this exercise.
3+
As the goal of this exercise is to learn about ternary operators consider using them in `%{inMethod}` to solve this exercise.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# use bitwise operator
22

3-
The `%<calledMethod>s` method should use the operator `%<operatorToUse>s`.
3+
The `%{calledMethod}` method should use the operator `%{operatorToUse}`.
44
As this concept exercise intends to teach how Bitwise operators work

0 commit comments

Comments
 (0)