Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(std): add some missing JSDoc ws/mod.ts #8428

Merged
merged 3 commits into from
Nov 25, 2020
Merged

docs(std): add some missing JSDoc ws/mod.ts #8428

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c3cc0ef
docs(srd): add some missing JSDoc ws/mod.ts
Nov 19, 2020
ad2fd9f
fix: deno run -A --unstable tools/format.js
Nov 20, 2020
7e872e5
fix: fit code style
Nov 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix: deno run -A --unstable tools/format.js
  • Loading branch information
赵皖华 committed Nov 20, 2020
commit ad2fd9f9f4a5fd709764c571bf969a244c76e370
6 changes: 3 additions & 3 deletions std/ws/mod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export interface WebSocketCloseEvent {

/**
* Returns true if input value is a WebSocketCloseEvent, false otherwise.
*/
*/
Copy link
Member

Choose a reason for hiding this comment

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

The formatting here is odd, and this could fit on a single line of text: https://deno.land/manual@v1.5.3/contributing/style_guide#use-jsdoc-for-exported-symbols

Copy link
Contributor Author

Choose a reason for hiding this comment

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

How about right now?

export function isWebSocketCloseEvent(
a: WebSocketEvent,
): a is WebSocketCloseEvent {
Expand All @@ -44,7 +44,7 @@ export type WebSocketPingEvent = ["ping", Uint8Array];

/**
* Returns true if input value is a WebSocketPingEvent, false otherwise.
*/
*/
export function isWebSocketPingEvent(
a: WebSocketEvent,
): a is WebSocketPingEvent {
Expand All @@ -55,7 +55,7 @@ export type WebSocketPongEvent = ["pong", Uint8Array];

/**
* Returns true if input value is a WebSocketPongEvent, false otherwise.
*/
*/
export function isWebSocketPongEvent(
a: WebSocketEvent,
): a is WebSocketPongEvent {
Expand Down