Skip to content

Commit e423b91

Browse files
dimodiikoevska
andauthored
docs(common): Do not use warning notes for error messages (#2091)
* docs(common): Do not use warning notes for error messages * Update knowledge-base/dropdowns-readonly-struct-error.md Co-authored-by: Iva Stefanova Koevska-Atanasova <[email protected]> --------- Co-authored-by: Iva Stefanova Koevska-Atanasova <[email protected]>
1 parent 3f3c28d commit e423b91

22 files changed

+113
-100
lines changed

knowledge-base/common-code-examples-in-documentation-do-not-compile.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ I am trying to run the code snippets in the documentation but they do not compil
2929

3030
## Error Message
3131

32-
>warning Unhandled Exception: System.MissingMethodException: Method not found: Microsoft.Extensions.DependencyInjection.IServiceCollection
32+
`Unhandled Exception: System.MissingMethodException: Method not found: Microsoft.Extensions.DependencyInjection.IServiceCollection`
3333

3434

3535
## Solution

knowledge-base/common-component-requires-telerikrootcomponent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ This knowledge base article explains how to avoid or fix the exception about a m
2828

2929
## Error Message
3030

31-
>warning Exception: A Telerik component on the requested view requires a TelerikRootComponent in MainLayout or a parent component.
31+
`Exception: A Telerik component on the requested view requires a TelerikRootComponent in MainLayout or a parent component.`
3232

3333

3434
## Cause

knowledge-base/common-connection-closed.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,15 +63,11 @@ Cannot import XSLX files which have a lot of records. It works for few records.
6363

6464
The exceptions may be similar to:
6565

66-
>warning Connection disconnected with error 'Error: Server returned an error on close: Connection closed with an error.'
67-
>
68-
Attempting to reconnect to the server...
66+
`Connection disconnected with error 'Error: Server returned an error on close: Connection closed with an error.' Attempting to reconnect to the server...`
6967

7068
Or:
7169

72-
>warning `System.Threading.Tasks.TaskCanceledException`
73-
>
74-
> `A task was canceled.`
70+
`System.Threading.Tasks.TaskCanceledException. A task was canceled.`
7571

7672
## Possible Cause
7773

knowledge-base/common-failed-to-find.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ I get a `Failed to find a valid digest in the 'integrity' attribute for resource
2626

2727
## Error Message
2828

29-
>warning Failed to find a valid digest in the 'integrity' attribute for resource 'https://.../_framework/Telerik.Recurrence.dll' with computed SHA-256 integrity ... The resource has been blocked.
30-
>
31-
> Unknown error occured while trying to verify integrity.
32-
>
33-
>Error: Failed to start platform. Reason: TypeError: Failed to fetch
29+
`Failed to find a valid digest in the 'integrity' attribute for resource 'https://.../_framework/Telerik.Recurrence.dll' with computed SHA-256 integrity ... The resource has been blocked.`
30+
31+
`Unknown error occured while trying to verify integrity.`
32+
33+
`Error: Failed to start platform. Reason: TypeError: Failed to fetch`
3434

3535
Other possible resources that may be referred to in the error:
3636
* Telerik.Documents.SpreadsheetStreaming.dll

knowledge-base/common-maximum-call-stack-exceeded.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ This knowledge base article deals with the `Maximum call stack size exceeded` er
2626

2727
## Error Message
2828

29-
>warning Microsoft.JSInterop.JSException: Maximum call stack size exceeded
30-
>
31-
> RangeError: Maximum call stack size exceeded
29+
`Microsoft.JSInterop.JSException: Maximum call stack size exceeded`
30+
31+
`RangeError: Maximum call stack size exceeded`
3232

3333
## Cause
3434

knowledge-base/common-null-value-parameter-format.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -29,22 +29,22 @@ I am getting an error when I am using a Telerik Blazor component in an applicati
2929

3030
The exact error message can vary. Here are just a few examples:
3131

32-
>warning Unhandled exception rendering component: Value cannot be null. (Parameter 'format')
33-
>
32+
```
33+
Unhandled exception rendering component: Value cannot be null. (Parameter 'format')
34+
```
35+
36+
```
3437
System.ArgumentNullException: Value cannot be null. (Parameter 'format')
35-
>
36-
at System.String.FormatHelper(IFormatProvider provider, String format, ParamsArray args)
37-
>
38-
at System.String.Format(String format, Object arg0, Object arg1)
39-
>
40-
at Telerik.Blazor.Components.TelerikWizard.get_PagerMessage()
41-
42-
>warning System.ArgumentNullException: Value cannot be null. (Parameter 'format')
43-
>
44-
at System.String.FormatHelper(IFormatProvider provider, String format, ParamsArray args)
45-
>
46-
at Telerik.Blazor.Components.Common.Filters.FilterMenu.TelerikFilterMenu.get_FilterMenuSettingsLabel()
38+
at System.String.FormatHelper(IFormatProvider provider, String format, ParamsArray args)
39+
at System.String.Format(String format, Object arg0, Object arg1)
40+
at Telerik.Blazor.Components.TelerikWizard.get_PagerMessage()
41+
```
4742

43+
```
44+
System.ArgumentNullException: Value cannot be null. (Parameter 'format')
45+
at System.String.FormatHelper(IFormatProvider provider, String format, ParamsArray args)
46+
at Telerik.Blazor.Components.Common.Filters.FilterMenu.TelerikFilterMenu.get_FilterMenuSettingsLabel()
47+
```
4848

4949
## Possible Cause
5050

knowledge-base/common-package-telerik-pivot-not-compatible-with-netframework.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,15 @@ This knowledge base article deals with the following issues:
3232

3333
## Error Message
3434

35-
>warning The nuget command failed with exit code and error
36-
>
37-
> NU1202: Package Telerik.Pivot.Core 0.1.1 is not compatible with net80 (.NETFramework,Version=v8.0). Package Telerik.Pivot.Core 0.1.1 supports: netstandard2.1 (.NETStandard,Version=v2.1)
38-
>
39-
> NU1202: Package Telerik.Pivot.DataProviders.Xmla 0.1.1 is not compatible with net80 (.NETFramework,Version=v8.0). Package Telerik.Pivot.DataProviders.Xmla 0.1.1 supports:
40-
netstandard2.1 (.NETStandard,Version=v2.1)
41-
>
42-
> Packages failed to restore.
35+
```
36+
The nuget command failed with exit code and error
37+
38+
NU1202: Package Telerik.Pivot.Core 0.1.1 is not compatible with net80 (.NETFramework,Version=v8.0). Package Telerik.Pivot.Core 0.1.1 supports: netstandard2.1 (.NETStandard,Version=v2.1)
39+
40+
NU1202: Package Telerik.Pivot.DataProviders.Xmla 0.1.1 is not compatible with net80 (.NETFramework,Version=v8.0). Package Telerik.Pivot.DataProviders.Xmla 0.1.1 supports: netstandard2.1 (.NETStandard,Version=v2.1)
41+
42+
Packages failed to restore.
43+
```
4344

4445
Similar errors can mention `net70 (.NETFramework,Version=v7.0)` or `net60 (.NETFramework,Version=v6.0)`.
4546

knowledge-base/common-partial-localization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,6 @@ The following repository contains translations provided by the community. You ca
6565

6666
Apart from missing localization strings, you may occasionally experience an error, similar to this one:
6767

68-
>warning Unhandled exception rendering component: Value cannot be null. (Parameter 'format')
68+
`Unhandled exception rendering component: Value cannot be null. (Parameter 'format')`
6969

7070
See knowledge base article [Value cannot be null. (Parameter 'format')]({%slug common-kb-null-value-parameter-format%}) for more details.

knowledge-base/dpl-allocate-memory-error.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,19 @@ When I try to Generate or Export documents through the Telerik Document Processi
2929

3030
## Error Message
3131

32-
>warning WASM: Error: Garbage collector could not allocate 16384 bytes of memory for major heap section
33-
34-
>warning WASM: * Assertion at /mnt/jenkins/workspace/test-mono-mainline-wasm/label/ubuntu-1804-amd64/mono/utils/lock-free-alloc.c:145, condition `sb_header' not met, function:alloc_sb, Failed to allocate memory for the lock free allocator
35-
36-
>warning dotnet.js:1 Uncaught RuntimeError: abort(undefined). Build with -s ASSERTIONS=1 for more info.
37-
> at abort (http://localhost:62774/_framework/wasm/dotnet.js:1:16107)
38-
> at _abort (http://localhost:62774/_framework/wasm/dotnet.js:1:117299)
32+
```
33+
WASM: Error: Garbage collector could not allocate 16384 bytes of memory for major heap section
34+
```
35+
36+
```
37+
WASM: * Assertion at /mnt/jenkins/workspace/test-mono-mainline-wasm/label/ubuntu-1804-amd64/mono/utils/lock-free-alloc.c:145, condition 'sb_header' not met, function:alloc_sb, Failed to allocate memory for the lock free allocator
38+
```
39+
40+
```
41+
dotnet.js:1 Uncaught RuntimeError: abort(undefined). Build with -s ASSERTIONS=1 for more info.
42+
at abort (http://localhost:62774/_framework/wasm/dotnet.js:1:16107)
43+
at _abort (http://localhost:62774/_framework/wasm/dotnet.js:1:117299)
44+
```
3945

4046

4147
## Possible Cause

knowledge-base/dropdowns-readonly-struct-error.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,13 @@ res_type: kb
2424
## Description
2525
When using the combo box component when the desired data is list of readonly structs there is a null reference exception and the combo box does not work.
2626

27+
## Error Message
28+
A typical error would be null reference exception like the one below:
29+
30+
```
31+
NullReferenceException: Object reference not set to an instance of an object.
32+
Telerik.Blazor.Components.TelerikComboBox<TItem, TValue>.<OnParametersSetAsync>b__70_0(ListDataItem item)
33+
```
2734

2835
## Steps to Reproduce
2936

@@ -53,12 +60,6 @@ Selected value: @selectedValue
5360
}
5461
````
5562

56-
## Error Message
57-
A typical error would be null reference exception like the one below
58-
59-
>warning NullReferenceException: Object reference not set to an instance of an object.
60-
Telerik.Blazor.Components.TelerikComboBox<TItem, TValue>.<OnParametersSetAsync>b__70_0(ListDataItem item)
61-
6263
## Possible Cause
6364
The components require a model when binding so it can be instantiated with a parameterless constructor. This is a requirement that comes down to the forms validation that they must support and getting the `Default` value and object. Structs do not have a parameterless constructor.
6465

0 commit comments

Comments
 (0)