issue-205: added comments for menu handlers methods. #218

Open
konstantinmds wants to merge 1 commits from konstantinmds/ussd:dev/issue-205 into master
First-time contributor

added comments for menu handlers methods.

added comments for menu handlers methods.
konstantinmds added 1 commit 2024-12-17 16:36:08 +01:00
added comments for menu handlers methods.
lash requested changes 2024-12-18 07:37:48 +01:00
lash left a comment
Owner

Thank you for your first contribution to our code. Please note the comment and make the corresponding change before we can merge.

Thank you for your first contribution to our code. Please note the comment and make the corresponding change before we can merge.
@ -80,6 +80,7 @@ type Handlers struct {
profile *models.Profile
}
// Creates a new instance of Handlers
Owner

In godoc, first word in the description of an exported symbol should be the symbol name, e.g. "NewHandlers creates a ..."

In godoc, first word in the description of an exported symbol should be the symbol name, e.g. "NewHandlers creates a ..."
konstantinmds force-pushed dev/issue-205 from 57e6ff86b4 to d946dfc577 2024-12-18 17:03:30 +01:00 Compare
konstantinmds requested review from lash 2024-12-19 09:52:23 +01:00
lash requested changes 2024-12-19 10:01:39 +01:00
lash left a comment
Owner

please let's also add punctuation for all comment sentences.

please let's also add punctuation for all comment sentences.
@ -231,6 +235,7 @@ func (h *Handlers) CreateAccount(ctx context.Context, sym string, input []byte)
return res, nil
}
// CheckPinMisMatch checks if the provided PIN matches a temporary PIN stored for a blocked number
Owner

@carlos is this correct, as it is only for blocked numbers? If so maybe this should be renamed to reflect this.

@carlos is this correct, as it is only for blocked numbers? If so maybe this should be renamed to reflect this.
Member

@lash Yeah that's correct. The CheckPinMisMatch checks the temporary PIN(unconfirmed PIN) when trying to reset a blocked number's PIN.

@lash Yeah that's correct. The `CheckPinMisMatch` checks the temporary PIN(unconfirmed PIN) when trying to reset a blocked number's PIN.
@ -930,6 +950,7 @@ func (h *Handlers) ResetOthersPin(ctx context.Context, sym string, input []byte)
return res, nil
}
// ResetUnregisteredNumber handles the cleanup of unregistered number flags in the system
Owner

Can this be more precise please?

Can this be more precise please?
@ -1957,6 +1984,7 @@ func (h *Handlers) ViewTransactionStatement(ctx context.Context, sym string, inp
return res, nil
}
// insertProfileItems handles bulk updates of profile information
Owner

function name is not needed for unexported symbols.

function name is not needed for unexported symbols.
This pull request has changes conflicting with the target branch.
  • internal/handlers/ussd/menuhandler.go

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u dev/issue-205:konstantinmds-dev/issue-205
git checkout konstantinmds-dev/issue-205
Sign in to join this conversation.
No reviewers
No Milestone
No project
No Assignees
3 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: urdt/ussd#218
No description provided.