Skip to content

Commit 6f6b7ec

Browse files
committed
d updated markdown snippets
1 parent 98df04e commit 6f6b7ec

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

approvaltests-util/docs/how_to/PerformanceProfilingWithSimpleLogger.md

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

33
# How to do Performance Profiling using SimpleLogger
44

5-
toc
5+
<!-- toc -->
6+
## Contents
7+
8+
* [Understanding timings in log output](#understanding-timings-in-log-output)<!-- endToc -->
69

710
## Understanding timings in log output
811
When SimpleLogger logs to a file or Standard.out it includes timings (these are turned off by default if you are logging
@@ -16,4 +19,4 @@ Here's an example of the output:
1619
[May 20, 2021, 9:44:17 PM ~000000ms] <= Sample.innerMethod() - OUT
1720
```
1821
The important part here is `~000047ms` which represents the number of milliseconds that have passed since the previous line SimpleLogger
19-
logged. This allows an easy way to detect bottlenecks by adding log statements and test improvements.
22+
logged. This allows an easy way to detect bottlenecks by adding log statements and test improvements.

approvaltests-util/docs/reference/SimpleLogger.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
## Contents
77

88
* [How SimpleLogger works](#how-simplelogger-works)
9+
* [Differences vs. System.out](#differences-vs-systemout)
10+
* [Differences vs. Log4J](#differences-vs-log4j)
11+
* [Logging method calls](#logging-method-calls)
912
* [HowTos](#howtos)
1013
* [SimpleLogger.logToNothing()](#simpleloggerlogtonothing)<!-- endToc -->
1114

@@ -123,5 +126,5 @@ if you want to turn them all off just run
123126
```java
124127
SimpleLogger.logToNothing();
125128
```
126-
<sup><a href='/approvaltests-util-tests/src/test/java/com/spun/util/logger/SimpleLoggerTest.java#L41-L43' title='Snippet source file'>snippet source</a> | <a href='#snippet-log_nothing' title='Start of snippet'>anchor</a></sup>
129+
<sup><a href='/approvaltests-util-tests/src/test/java/com/spun/util/logger/SimpleLoggerTest.java#L52-L54' title='Snippet source file'>snippet source</a> | <a href='#snippet-log_nothing' title='Start of snippet'>anchor</a></sup>
127130
<!-- endSnippet -->

0 commit comments

Comments
 (0)