Skip to content

Commit

Permalink
fix doc typo (#171)
Browse files Browse the repository at this point in the history
* fix trim trailing whitespace problem on markdown file

* fix matcher-DSL
 doc

* fix Markdown table problem
> For compatibility reasons all table rows should have borders (pipe symbols) at the start and at the end

* fix word typo problem in user manual

* fix wrong word

Co-authored-by: jxd134 <[email protected]>
  • Loading branch information
jxd134 and jxd1990 authored Jan 2, 2022
1 parent 5768c27 commit 0bf1e62
Show file tree
Hide file tree
Showing 5 changed files with 92 additions and 90 deletions.
3 changes: 3 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,6 @@ indent_size = 4
trim_trailing_whitespace = true
insert_final_newline = true
end_of_line = lf

[*.md]
trim_trailing_whitespace = false
2 changes: 1 addition & 1 deletion doc/context.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ public interface Context {
* Check task is wrapped.
*
* @param task Runnable
* @return true if task is warpped.
* @return true if task is wrapped.
*/
boolean isWrapped(Runnable task);

Expand Down
6 changes: 3 additions & 3 deletions doc/matcher-DSL.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ In addition, `ClassMatcherBuilder` provides `and()` method which will finish cur
The previous builder will generate a `Left ClassMatcher` and the new builder will generate a 'Right ClassMatcher'.
The `Left matcher` and `Right matcher` will be combined into one `AndClassMatcher`, and a method will match as long as the `Left` or `Right` matcher is a match.

For example, the following matcher will will match classes that inherit the `easeagent.test.TestBaseClass` class **and** exclude classes implementing "easeagent.test.InterfaceB" interface.
For example, the following matcher will match classes that inherit the `easeagent.test.TestBaseClass` class **and** exclude classes implementing "easeagent.test.InterfaceB" interface.

```
matcher = ClassMatcher.builder()
Expand Down Expand Up @@ -120,7 +120,7 @@ As defined by the JVM Specification for the method structure , the optional elem
- Method name.
- Modifier, public/private, and so on.
- Argument type, the full qualified class name of argument.
- ReturnType, the return type of a method.
- ReturnType, the return type of method.

### Implementation

Expand Down Expand Up @@ -157,7 +157,7 @@ The following methods are common condition settings in method matching,
MethodMatcherBuilder nameStartWith(String methodName);
MethodMatcherBuilder nameEndWith(String methodName);
MethodMatcherBuilder nameContains(String methodName);

// modifier condition
MethodMatcherBuilder isPublic();
MethodMatcherBuilder isPrivate();
Expand Down
2 changes: 1 addition & 1 deletion doc/tracing-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ interface Context{
* Check task is wrapped.
*
* @param task Runnable
* @return true if task is warpped.
* @return true if task is wrapped.
*/
boolean isWrapped(Runnable task);

Expand Down
Loading

0 comments on commit 0bf1e62

Please sign in to comment.