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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Commenting gate.ts #2635

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Commenting gate.ts #2635

wants to merge 1 commit into from

Conversation

sadasant
Copy link
Contributor

@sadasant sadasant commented Apr 14, 2023 •
edited

Notes:

  • I believe this PR doesn't need a changeling entry, or does it? Since it's just documentation.
  • Feedback always appreciated!

Description

While reading the codebase, I was briefly confused by the gate decorator.

For a second, I thought gate to what?

I'm hoping these comments will help others dive through the codebase as well 馃檪

Fixes #2634

Checklist

  • I have followed the guidelines in the Contributing document
  • My changes follow the coding style of this project
  • My changes build without any errors or warnings
  • My changes have been formatted and linted
  • TODO: My changes include any required corresponding changes to the documentation (including CHANGELOG.md and README.md)
  • TODO: My changes have been rebased and squashed to the minimal number (typically 1) of relevant commits
  • TODO: My changes have a descriptive commit message with a short title, including a Fixes $XXX - or Closes #XXX - prefix to auto-close the issue that your PR addresses

@sadasant
Copy link
Contributor Author

Lunch, brb.

@sadasant
Fixes gitkraken#2634 - Comments gate.ts
f01c3fb 
While reading the codebase, I was briefly confused by the gate decorator.
Here, I've added comments to the decorator to make it easier to understand.
I'm hoping these comments will help others dive through the codebase as well 馃檪
@sadasant sadasant marked this pull request as ready for review April 14, 2023 22:17
@d13 d13 self-assigned this Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@d13 d13

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Let's document the gate decorator!
2 participants
@sadasant @d13