Skip to content

Simplify async interface docs terminology #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
glopesdev merged 1 commit into from
Mar 22, 2026
Merged

Simplify async interface docs terminology #116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/AsyncDevice.tt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ foreach (var registerMetadata in publicRegisters)
/// A <see cref="CancellationToken"/> which can be used to cancel the operation.
/// </param>
/// <returns>
/// A task that represents the asynchronous read operation. The <see cref="Task{TResult}.Result"/>
/// property contains the register payload.
/// A task that represents the asynchronous read operation. The task result contains
/// the register payload.
/// </returns>
public async Task<<#= interfaceType #>> Read<#= registerMetadata.Key #>Async(CancellationToken cancellationToken = default)
{
Expand All @@ -91,8 +91,8 @@ foreach (var registerMetadata in publicRegisters)
/// A <see cref="CancellationToken"/> which can be used to cancel the operation.
/// </param>
/// <returns>
/// A task that represents the asynchronous read operation. The <see cref="Task{TResult}.Result"/>
/// property contains the timestamped register payload.
/// A task that represents the asynchronous read operation. The task result contains
/// the timestamped register payload.
/// </returns>
public async Task<Timestamped<<#= interfaceType #>>> ReadTimestamped<#= registerMetadata.Key #>Async(CancellationToken cancellationToken = default)
{
Expand All @@ -107,7 +107,7 @@ foreach (var registerMetadata in publicRegisters)
/// <summary>
/// Asynchronously writes a value to the <see cref="<#= registerMetadata.Key #>"/> register.
/// </summary>
/// <param name="value">The value to be stored in the register.</param>
/// <param name="value">The value to write in the register.</param>
/// <param name="cancellationToken">
/// A <see cref="CancellationToken"/> which can be used to cancel the operation.
/// </param>
Expand Down
Loading
Loading