Apply suggestions from code review

Some textual tweaks.

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
This commit is contained in:
Michael Kaye 2022-01-21 11:45:58 +00:00 committed by GitHub
parent a5d3006fe0
commit bbe36198b7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,14 +1,14 @@
# Common report styles. # Common report styles
Rageshakes can come from a number of applications, and we provide some practical notes on the generated format. Rageshakes can come from a number of applications, and we provide some practical notes on the generated format.
At present these should not be considered absolute nor a structure to follow; but an attempt to document the At present these should not be considered absolute nor a structure to follow; but an attempt to document the
currently visible formats as of January 2022 currently visible formats as of January 2022.
## Feedback ## Feedback
Log files are not transmitted, the main feedback is entirely within the user message body. Log files are not transmitted; the main feedback is entirely within the user message body.
## Element Web ## Element Web
@ -57,9 +57,9 @@ console-share-49.log (oldest)
## Element Android ## Element Android
There is a historical issue with the naming of files, documented in issue #40 There is a historical issue with the naming of files, documented in [issue #40](https://github.com/matrix-org/rageshake/issues/40).
Log file 0000 is odd, it contains the logcat data if sent Log file 0000 is odd, it contains the logcat data if sent.
Log line format: Log line format:
``` ```
@ -78,7 +78,7 @@ Log line format:
L = log level, (W=Warn, I=Info, etc) L = log level, (W=Warn, I=Info, etc)
``` ```
Once the fix is in place, we will see the following files: Once the fix to #40 is in place, we will see the following files:
``` ```
logcatError.log logcatError.log