diff --git a/docs/submitted_reports.md b/docs/submitted_reports.md index 67c2728..327392d 100644 --- a/docs/submitted_reports.md +++ b/docs/submitted_reports.md @@ -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. 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 -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 @@ -57,9 +57,9 @@ console-share-49.log (oldest) ## 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: ``` @@ -78,7 +78,7 @@ Log line format: 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