Skip to content

Commit 030a054

Browse files
authored
Simplify async interface docs terminology (#116)
Generic type references are removed for simplicity. We also change the phrasing describing the value parameter of Write methods to work with pure function calls coming soon.
1 parent 59d0107 commit 030a054

File tree

2 files changed

+68
-68
lines changed

2 files changed

+68
-68
lines changed

src/AsyncDevice.tt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@ foreach (var registerMetadata in publicRegisters)
7575
/// A <see cref="CancellationToken"/> which can be used to cancel the operation.
7676
/// </param>
7777
/// <returns>
78-
/// A task that represents the asynchronous read operation. The <see cref="Task{TResult}.Result"/>
79-
/// property contains the register payload.
78+
/// A task that represents the asynchronous read operation. The task result contains
79+
/// the register payload.
8080
/// </returns>
8181
public async Task<<#= interfaceType #>> Read<#= registerMetadata.Key #>Async(CancellationToken cancellationToken = default)
8282
{
@@ -91,8 +91,8 @@ foreach (var registerMetadata in publicRegisters)
9191
/// A <see cref="CancellationToken"/> which can be used to cancel the operation.
9292
/// </param>
9393
/// <returns>
94-
/// A task that represents the asynchronous read operation. The <see cref="Task{TResult}.Result"/>
95-
/// property contains the timestamped register payload.
94+
/// A task that represents the asynchronous read operation. The task result contains
95+
/// the timestamped register payload.
9696
/// </returns>
9797
public async Task<Timestamped<<#= interfaceType #>>> ReadTimestamped<#= registerMetadata.Key #>Async(CancellationToken cancellationToken = default)
9898
{
@@ -107,7 +107,7 @@ foreach (var registerMetadata in publicRegisters)
107107
/// <summary>
108108
/// Asynchronously writes a value to the <see cref="<#= registerMetadata.Key #>"/> register.
109109
/// </summary>
110-
/// <param name="value">The value to be stored in the register.</param>
110+
/// <param name="value">The value to write in the register.</param>
111111
/// <param name="cancellationToken">
112112
/// A <see cref="CancellationToken"/> which can be used to cancel the operation.
113113
/// </param>

0 commit comments

Comments
 (0)