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.

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

fix(blocks): Mark previously-@private methods @internal #7194

Merged
merged 1 commit into from
Jun 21, 2023

Conversation

cpcallen
Copy link
Contributor

@cpcallen cpcallen commented Jun 21, 2023

The basics

  • I branched from develop
  • My pull request is against develop
  • My code follows the style guide
  • I ran npm run format and npm run lint

The details

Proposed Changes

Where certain block mixin methods had been marked @private, and these annotations had been deleted while migrating the containing files to TypeScript, mark those methods as @internal.

Behaviour Before Change

These methods might have appeared in our .d.ts files and external documentation.

Behaviour After Change

These methods should not appear in our d.ts files or external documentation.

Reason for Changes

The migration PRs were not intended to change any API.

Test Coverage

Passes npm test. No changes to manual testing required.

Documentation

…may be sparser than before, intentionally.

Additional Information

I'm not actually sure if these methods appear in our external documentation at the moment—I'd guess not. But better to keep it that way.

Where certain block mixin methods had been marked @Private,
and these annotations had been deleted while migrating the
containing files to TypeScript, mark those methods as
@internal.
@cpcallen cpcallen requested a review from BeksOmega June 21, 2023 19:26
@cpcallen cpcallen requested a review from a team as a code owner June 21, 2023 19:26
@github-actions github-actions bot added the PR: fix Fixes a bug label Jun 21, 2023
Copy link
Collaborator

@BeksOmega BeksOmega left a comment

Choose a reason for hiding this comment

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

One meta comment: Make sure to put @private and @internal in back ticks, otherwise we @ people we don't want to :P

@github-actions github-actions bot added PR: fix Fixes a bug and removed PR: fix Fixes a bug labels Jun 21, 2023
@cpcallen cpcallen merged commit ea74772 into google:develop Jun 21, 2023
@cpcallen
Copy link
Contributor Author

One meta comment: Make sure to put @private and @internal in back ticks, otherwise we @ people we don't want to

Oops. But also: whoever started using @username instead of username@ gets a big ಠ_ಠ from me.

@cpcallen cpcallen deleted the fix/6828/blocks/@internal branch June 21, 2023 19:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants