Skip to content

Conversation

@Bashamega
Copy link
Contributor

This way all the interfaces have comments, even overwritten ones.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 6, 2025

Thanks for the PR!

This section of the codebase is owned by @saschanaz - if they write a comment saying "LGTM" then it will be merged.

Copy link
Contributor

@saschanaz saschanaz left a comment

Choose a reason for hiding this comment

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

This way we can't override comments, but we probably won't ever do that. LGTM thus.

* [MDN Reference](https://developer.mozilla.org/docs/Web/API/CompressionStream)
*/
interface CompressionStream extends GenericTransformStream {
/** The **`readable`** read-only property of the CompressionStream interface returns a ReadableStream. */
Copy link
Member

Choose a reason for hiding this comment

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

Wow, what useless comments... Who is providing these?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

MDN, they are from MDN

Copy link
Member

Choose a reason for hiding this comment

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

It's a shame we are wasting parsing time and memory on these comments that just restate the annotation 😞

Copy link
Contributor Author

Choose a reason for hiding this comment

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

But some comments are useful

Copy link
Member

@jakebailey jakebailey Nov 6, 2025

Choose a reason for hiding this comment

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

Some are absolutely, I am just lamenting comments that are just:

interface Foo {
    // The **`bar`** read-only property of the Foo interface returns a string
    readonly bar: string;
}

@saschanaz
Copy link
Contributor

LGTM. Yeah some comments are basically not anything more than placeholders, but we don't have a great way to filter them without adding some magic, which I don't want to. 😔

@github-actions github-actions bot merged commit 89714d0 into microsoft:main Nov 6, 2025
13 of 14 checks passed
@github-actions
Copy link
Contributor

github-actions bot commented Nov 6, 2025

Merging because @saschanaz is a code-owner of all the changes - thanks!

@saschanaz saschanaz deleted the comments branch November 6, 2025 22:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants