Skip to content

Different names for CancellationToken #2240

@Nice3point

Description

@Nice3point

Can we unify the parameter name for CancellationToken?

Git commands - token:

public interface IGitCommands
{
    Task<CommandResult> Add(GitAddOptions options, CommandExecutionOptions? executionOptions = null, CancellationToken token = default);

    Task<CommandResult> Am(GitAmOptions options, CommandExecutionOptions? executionOptions = null, CancellationToken token = default);

    Task<CommandResult> Apply(GitApplyOptions options, CommandExecutionOptions? executionOptions = null, CancellationToken token = default);
}

Dotnet commands - cancellationToken:

public partial interface IDotNet
{
    Task<CommandResult> Build(DotNetBuildOptions? options = default, CommandExecutionOptions? executionOptions = null, CancellationToken cancellationToken = default);

    Task<CommandResult> Clean(DotNetCleanOptions? options = default, CommandExecutionOptions? executionOptions = null, CancellationToken cancellationToken = default);
}

I guess better to use CancellationToken cancellationToken = default everywhere, its a default naming in .NET.

Unified naming can be useful because its an optional parameter and better to write like here and dont care about different names:

        await context.DotNet().Build(new DotNetBuildOptions
        {
             ...
        }, cancellationToken: cancellationToken);

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions