diff --git a/changelog.d/428.misc b/changelog.d/428.misc new file mode 100644 index 00000000..280f9b2e --- /dev/null +++ b/changelog.d/428.misc @@ -0,0 +1 @@ +Correct the docstrings of some connection classes. diff --git a/src/Connections/GenericHook.ts b/src/Connections/GenericHook.ts index 9f5902a7..15b2e0ef 100644 --- a/src/Connections/GenericHook.ts +++ b/src/Connections/GenericHook.ts @@ -60,7 +60,7 @@ const SANITIZE_MAX_DEPTH = 5; const SANITIZE_MAX_BREADTH = 25; /** - * Handles rooms connected to a github repo. + * Handles rooms connected to a generic webhook. */ @Connection export class GenericHookConnection extends BaseConnection implements IConnection { diff --git a/src/Connections/GithubDiscussion.ts b/src/Connections/GithubDiscussion.ts index 85ec56aa..49013b1d 100644 --- a/src/Connections/GithubDiscussion.ts +++ b/src/Connections/GithubDiscussion.ts @@ -26,7 +26,7 @@ const log = new LogWrapper("GitHubDiscussion"); const md = new markdown(); /** - * Handles rooms connected to a github repo. + * Handles rooms connected to a GitHub discussion. */ @Connection export class GitHubDiscussionConnection extends BaseConnection implements IConnection { diff --git a/src/Connections/GithubDiscussionSpace.ts b/src/Connections/GithubDiscussionSpace.ts index 727e3999..39b9b959 100644 --- a/src/Connections/GithubDiscussionSpace.ts +++ b/src/Connections/GithubDiscussionSpace.ts @@ -15,7 +15,7 @@ export interface GitHubDiscussionSpaceConnectionState { } /** - * Handles rooms connected to a github repo. + * Handles spaces connected to a GitHub discussion. */ @Connection export class GitHubDiscussionSpace extends BaseConnection implements IConnection { diff --git a/src/Connections/GithubIssue.ts b/src/Connections/GithubIssue.ts index 7a100672..654b4e14 100644 --- a/src/Connections/GithubIssue.ts +++ b/src/Connections/GithubIssue.ts @@ -36,7 +36,7 @@ interface IQueryRoomOpts { } /** - * Handles rooms connected to a github repo. + * Handles rooms connected to a GitHub issue. */ @Connection export class GitHubIssueConnection extends BaseConnection implements IConnection { diff --git a/src/Connections/GithubProject.ts b/src/Connections/GithubProject.ts index 9d697944..8b3ff296 100644 --- a/src/Connections/GithubProject.ts +++ b/src/Connections/GithubProject.ts @@ -12,7 +12,7 @@ export interface GitHubProjectConnectionState { const log = new LogWrapper("GitHubProjectConnection"); /** - * Handles rooms connected to a github repo. + * Handles rooms connected to a GitHub project. */ @Connection export class GitHubProjectConnection extends BaseConnection implements IConnection { diff --git a/src/Connections/GithubRepo.ts b/src/Connections/GithubRepo.ts index a3ce65dd..4e7b5a32 100644 --- a/src/Connections/GithubRepo.ts +++ b/src/Connections/GithubRepo.ts @@ -209,7 +209,7 @@ function compareEmojiStrings(e0: string, e1: string, e0Index = 0) { } /** - * Handles rooms connected to a github repo. + * Handles rooms connected to a GitHub repo. */ @Connection export class GitHubRepoConnection extends CommandConnection implements IConnection { diff --git a/src/Connections/GithubUserSpace.ts b/src/Connections/GithubUserSpace.ts index a57d50fa..93de4beb 100644 --- a/src/Connections/GithubUserSpace.ts +++ b/src/Connections/GithubUserSpace.ts @@ -14,7 +14,7 @@ export interface GitHubUserSpaceConnectionState { } /** - * Handles rooms connected to a github repo. + * Handles spaces connected to a GitHub user. */ @Connection export class GitHubUserSpace extends BaseConnection implements IConnection { diff --git a/src/Connections/GitlabIssue.ts b/src/Connections/GitlabIssue.ts index cf952520..2d496656 100644 --- a/src/Connections/GitlabIssue.ts +++ b/src/Connections/GitlabIssue.ts @@ -31,7 +31,7 @@ const log = new LogWrapper("GitLabIssueConnection"); // } /** - * Handles rooms connected to a github repo. + * Handles rooms connected to a GitLab issue. */ @Connection export class GitLabIssueConnection extends BaseConnection implements IConnection { diff --git a/src/Connections/GitlabRepo.ts b/src/Connections/GitlabRepo.ts index 9ee4a577..1c24f73d 100644 --- a/src/Connections/GitlabRepo.ts +++ b/src/Connections/GitlabRepo.ts @@ -127,7 +127,7 @@ export interface GitLabTargetFilter { } /** - * Handles rooms connected to a github repo. + * Handles rooms connected to a GitLab repo. */ @Connection export class GitLabRepoConnection extends CommandConnection { diff --git a/src/Connections/JiraProject.ts b/src/Connections/JiraProject.ts index 3caeefcb..53a2afb6 100644 --- a/src/Connections/JiraProject.ts +++ b/src/Connections/JiraProject.ts @@ -47,7 +47,7 @@ const log = new LogWrapper("JiraProjectConnection"); const md = new markdownit(); /** - * Handles rooms connected to a github repo. + * Handles rooms connected to a Jira project. */ @Connection export class JiraProjectConnection extends CommandConnection implements IConnection {