issue-205: added comments for menu handlers methods. #218
No reviewers
Labels
No Label
Compat/Breaking
Kind/Bug
Kind/Documentation
Kind/Enhancement
Kind/Feature
Kind/Security
Kind/Testing
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Reviewed
Confirmed
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Status
Abandoned
Status
Blocked
Status
Need More Info
Activity
Doing
Activity
Proposal
Activity
QA
Activity
Validate
Runner
AT
Runner
CLI
Runner
HTTP
Runner
SSH
cleanup
devops
documentation
easypeasy
exchange
i18n
l8ter
legacy
meta
migration
optimization
privilege
refactor
smell
support
tooling
ux
No Milestone
No project
No Assignees
3 Participants
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: urdt/ussd#218
Loading…
Reference in New Issue
Block a user
No description provided.
Delete Branch "konstantinmds/ussd:dev/issue-205"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
added comments for menu handlers methods.
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
In godoc, first word in the description of an exported symbol should be the symbol name, e.g. "NewHandlers creates a ..."
57e6ff86b4
tod946dfc577
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
@carlos is this correct, as it is only for blocked numbers? If so maybe this should be renamed to reflect this.
@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
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
function name is not needed for unexported symbols.
Checkout
From your project repository, check out a new branch and test the changes.