From f8f7aea66f938146359096c0787021fc1ca7dc7c Mon Sep 17 00:00:00 2001 From: "Collin M. Barrett" Date: Sat, 27 Nov 2021 13:15:49 -0600 Subject: [PATCH] =?UTF-8?q?docs(dir):=20=F0=9F=93=84=E2=99=BB=20lint=20end?= =?UTF-8?q?point=20summaries?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../Controllers/ChangesController.cs | 4 ++-- .../Controllers/LanguagesController.cs | 4 ++-- .../Controllers/LicensesController.cs | 4 ++-- .../FilterLists.Directory.Api/Controllers/ListsController.cs | 2 +- .../Controllers/MaintainersController.cs | 4 ++-- .../Controllers/SoftwareController.cs | 4 ++-- .../Controllers/SyntaxesController.cs | 4 ++-- .../FilterLists.Directory.Api/Controllers/TagsController.cs | 4 ++-- 8 files changed, 15 insertions(+), 15 deletions(-) diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/ChangesController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/ChangesController.cs index 2cd43e23f..281ea3a71 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/ChangesController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/ChangesController.cs @@ -17,7 +17,7 @@ public ChangesController(IMemoryCache cache, IMediator mediator) : base(cache) } /// - /// Gets the changes. + /// ALPHA: Gets the changes to the FilterLists database pending approval. /// /// The cancellation token. /// The changes. @@ -29,7 +29,7 @@ public Task Get(CancellationToken cancellationToken) } /// - /// Gets the change. + /// ALPHA: Gets the change to the FilterLists database. /// /// The identifier of the change. /// The cancellation token. diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/LanguagesController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/LanguagesController.cs index 7888d0eb4..0ed595d06 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/LanguagesController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/LanguagesController.cs @@ -15,10 +15,10 @@ public LanguagesController(IMemoryCache cache, IMediator mediator) : base(cache) } /// - /// Gets the languages targeted by FilterLists. + /// Gets the languages targeted by the FilterLists. /// /// The cancellation token. - /// The languages targeted by FilterLists. + /// The languages targeted by the FilterLists. [HttpGet] [ProducesResponseType(typeof(IEnumerable), StatusCodes.Status200OK)] public Task Get(CancellationToken cancellationToken) diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/LicensesController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/LicensesController.cs index e0f507610..c32c22167 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/LicensesController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/LicensesController.cs @@ -15,10 +15,10 @@ public LicensesController(IMemoryCache cache, IMediator mediator) : base(cache) } /// - /// Gets the licenses applied to FilterLists. + /// Gets the licenses applied to the FilterLists. /// /// The cancellation token. - /// The licenses applied to FilterLists. + /// The licenses applied to the FilterLists. [HttpGet] [ProducesResponseType(typeof(IEnumerable), StatusCodes.Status200OK)] public Task Get(CancellationToken cancellationToken) diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/ListsController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/ListsController.cs index 9cfd08773..6464ab665 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/ListsController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/ListsController.cs @@ -31,7 +31,7 @@ public Task Get(CancellationToken cancellationToken) #if DEBUG /// - /// Creates the FilterList. + /// ALPHA: Creates the FilterList pending moderator approval. /// /// The command. /// The cancellation token. diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/MaintainersController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/MaintainersController.cs index 57d367900..4ee3cc305 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/MaintainersController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/MaintainersController.cs @@ -15,10 +15,10 @@ public MaintainersController(IMemoryCache cache, IMediator mediator) : base(cach } /// - /// Gets the maintainers of FilterLists. + /// Gets the maintainers of the FilterLists. /// /// The cancellation token. - /// The maintainers of FilterLists. + /// The maintainers of the FilterLists. [HttpGet] [ProducesResponseType(typeof(IEnumerable), StatusCodes.Status200OK)] public Task Get(CancellationToken cancellationToken) diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/SoftwareController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/SoftwareController.cs index 2c367b3cf..0f08aae17 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/SoftwareController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/SoftwareController.cs @@ -15,10 +15,10 @@ public SoftwareController(IMemoryCache cache, IMediator mediator) : base(cache) } /// - /// Gets the software that subscribes to FilterLists. + /// Gets the software that subscribes to the FilterLists. /// /// The cancellation token. - /// The software that subscribes to FilterLists. + /// The software that subscribes to the FilterLists. [HttpGet] [ProducesResponseType(typeof(IEnumerable), StatusCodes.Status200OK)] public Task Get(CancellationToken cancellationToken) diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/SyntaxesController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/SyntaxesController.cs index 2e885a21b..4c0d5260d 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/SyntaxesController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/SyntaxesController.cs @@ -15,10 +15,10 @@ public SyntaxesController(IMemoryCache cache, IMediator mediator) : base(cache) } /// - /// Gets the syntaxes of FilterLists. + /// Gets the syntaxes of the FilterLists. /// /// The cancellation token. - /// The syntaxes of FilterLists. + /// The syntaxes of the FilterLists. [HttpGet] [ProducesResponseType(typeof(IEnumerable), StatusCodes.Status200OK)] public Task Get(CancellationToken cancellationToken) diff --git a/services/Directory/FilterLists.Directory.Api/Controllers/TagsController.cs b/services/Directory/FilterLists.Directory.Api/Controllers/TagsController.cs index 38d7c1f8b..df76be42a 100644 --- a/services/Directory/FilterLists.Directory.Api/Controllers/TagsController.cs +++ b/services/Directory/FilterLists.Directory.Api/Controllers/TagsController.cs @@ -15,10 +15,10 @@ public TagsController(IMemoryCache cache, IMediator mediator) : base(cache) } /// - /// Gets the tags of FilterLists. + /// Gets the tags of the FilterLists. /// /// The cancellation token. - /// The tags of FilterLists. + /// The tags of the FilterLists. [HttpGet] [ProducesResponseType(typeof(IEnumerable), StatusCodes.Status200OK)] public Task Get(CancellationToken cancellationToken)