Skip to content
This repository was archived by the owner on Jul 30, 2022. It is now read-only.

Add tsdoc on structures - #33

Open
lahgolz wants to merge 4 commits into
developfrom
doc/tsdoc
Open

Add tsdoc on structures#33
lahgolz wants to merge 4 commits into
developfrom
doc/tsdoc

Conversation

@lahgolz

@lahgolz lahgolz commented Jun 7, 2021

Copy link
Copy Markdown
Contributor

No description provided.

@lahgolz
lahgolz requested a review from Mesteery June 7, 2021 18:30
Comment thread src/clients/Client.ts
import type { DeepRequired } from '../utils';
import { GatewayException } from '../exceptions';
import { BaseClient } from './BaseClient';
import type { HttpOptions } from '../http';

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you revet imports order changes?

Comment thread src/clients/Client.ts
/**
* Discord's gateway version.
* @default 8
* @defaultValue 8

@Mesteery Mesteery Jun 19, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

defaultValue `8` or defaultValue 8 ?

@@ -4,27 +4,109 @@ import { deconstruct } from '../utils/Snowflake';
import { Team } from './team/Team';
import { User } from './User';

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you explain why and when some fields can be nullable?

Comment thread src/structures/Invite.ts
@@ -5,23 +5,93 @@ import { GuildChannel } from './channel/GuildChannel';
import { Guild } from './guild/Guild';
import { User } from './User';

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same about nullable fields.

/**
* The user(s) of the DM
*/
public recipients = new Collection<Snowflake, User>();

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why users?

*/
public author?: User;

public $patch(data: APIEmoji): void {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use TSDoc's @private

@Mesteery Mesteery added doc Improvements or additions to documentation wip Issues and PRs that are still a work in progress labels Jul 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

doc Improvements or additions to documentation wip Issues and PRs that are still a work in progress

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants