Skip to content

Commit c093b16

Browse files
committed
Some more README polishing.
1 parent 08f0e53 commit c093b16

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,12 @@ The [`IDSMRTelegramParser`](DSMRParser/IDSMRTelegramParser.cs) interface has the
5252
```c#
5353
Telegram Parse(Span<byte> telegram);
5454
```
55-
However, the [default implementation](DSMRParser/DSMRTelegramParser.cs) provides a few useful additional methods, show (simplified) below:
55+
However, the [default implementation](DSMRParser/DSMRTelegramParser.cs) provides a few useful additional methods, shown (simplified) below:
5656
```c#
57-
public Telegram Parse(Span<byte> telegram, bool ignoreCrc = false)
58-
public Telegram Parse(string telegram, bool ignoreCrc = false)
59-
public bool TryParse(Span<byte> telegram, bool ignoreCrc = false, out Telegram? result)
60-
public bool TryParse(string telegram, bool ignoreCrc = false, out Telegram? result)
57+
Telegram Parse(Span<byte> telegram, bool ignoreCrc = false)
58+
Telegram Parse(string telegram, bool ignoreCrc = false)
59+
bool TryParse(Span<byte> telegram, bool ignoreCrc = false, out Telegram? result)
60+
bool TryParse(string telegram, bool ignoreCrc = false, out Telegram? result)
6161
```
6262

6363
Since this API follows .Net conventions, usage shouldn't be a surprise. The `Parse` method will throw an exception if the telegram is invalid, while `TryParse` will return a boolean indicating success or failure and provide the result in the `out` argument. The `telegram` can be provided as string or as `Span<byte>` and the `ignoreCrc` does what it says on the tin: it ignores issues with the CRC.

0 commit comments

Comments
 (0)