Skip to content

Commit

Permalink
docs: fix some issues on custom logger documentation (#32)
Browse files Browse the repository at this point in the history
  • Loading branch information
kurtmkurtm authored Sep 18, 2022
1 parent 8cde737 commit a35b7ef
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ The custom logger package allows you to create your own reports simply by passin

`dotnet add package LiquidTestReports.Custom`

2. Add a new text file to your test project, and set `Copy to Output Directory` as`Copy always`, below is a starting sample template
2. Add a new text file to your test project, and set `Copy to Output Directory` as `Copy always`, below is a starting sample template

```TemplateExample.txt
Test Statistics:
Expand All @@ -149,7 +149,7 @@ The custom logger package allows you to create your own reports simply by passin

3. Run the tests using the supplied logger

`dotnet test --logger "liquid.custom;TemplateExample.txt"`
`dotnet test --logger "liquid.custom;Template=TemplateExample.txt"`

4. Report will be generated in the test results folder

Expand Down
6 changes: 4 additions & 2 deletions docs/Properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,8 +242,9 @@ Executor URI: {{test_case.executor_uri}}
Source: {{test_case.source}}
Code File Path: {{test_case.code_file_path}}
Line Number: {{test_case.line_number}}
Traits: {{test_case.traits | first}}
Traits:
{% for trait in test_case.traits %}[{{ trait.Name }} : {{ trait.Value }}]</br>
{% endfor %}
```

Expand Down Expand Up @@ -283,6 +284,7 @@ Source: C:\github\LiquidTestReports\test\SampleProject\SampleProject.Tests.xUnit
Code File Path:
Line Number: 0
Traits:
[ReportName : My Test Theory]</br>
```


Expand Down
10 changes: 8 additions & 2 deletions docs/PropertiesRaw.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,10 @@ Executor URI: {{test_case.executor_uri}}
Source: {{test_case.source}}
Code File Path: {{test_case.code_file_path}}
Line Number: {{test_case.line_number}}
Traits: {{test_case.traits | first}}
Traits:
{%- for trait in test_case.traits -%}
[{{ trait.Name }} : {{ trait.Value }}]</br>
{%- endfor -%}
{% endraw %}
```
Expand Down Expand Up @@ -281,7 +284,10 @@ Executor URI: {{test_case.executor_uri}}
Source: {{test_case.source}}
Code File Path: {{test_case.code_file_path}}
Line Number: {{test_case.line_number}}
Traits: {{test_case.traits | first}}
Traits:
{%- for trait in test_case.traits -%}
[{{ trait.Name }} : {{ trait.Value }}]</br>
{%- endfor -%}
```


Expand Down
2 changes: 1 addition & 1 deletion src/LiquidTestReports.Custom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ Not Found: {{ run.test_run_statistics.not_found_count }}
Total: {{ run.test_run_statistics.executed_tests_count }}
```
3. Run the tests using the supplied logger
- `dotnet test --logger "liquid.custom;TemplateExample.txt"`
- `dotnet test --logger "liquid.custom;Template=TemplateExample.txt"`
4. Report will be generated in the test results folder

0 comments on commit a35b7ef

Please sign in to comment.