Fix some docstrings (#428)

* Fix some docstrings

* changelog
This commit is contained in:
Andrew Ferrazzutti 2022-07-28 10:33:28 -04:00 committed by GitHub
parent 1018ca119f
commit b118a8e606
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 11 additions and 10 deletions

1
changelog.d/428.misc Normal file
View File

@ -0,0 +1 @@
Correct the docstrings of some connection classes.

View File

@ -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 {

View File

@ -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 {

View File

@ -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 {

View File

@ -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 {

View File

@ -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 {

View File

@ -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 {

View File

@ -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 {

View File

@ -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 {

View File

@ -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 {

View File

@ -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 {