urdt/ussd
5
0
Fork 1
Code Issues 41 Pull Requests Actions Packages Projects Releases Wiki Activity

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

Merged
lash merged 1 commits from konstantinmds/ussd:dev/issue-205 into master 2024-12-27 12:58:01 +01:00
Conversation 3 Commits 1 Files Changed 2 +78 -49
konstantinmds commented 2024-12-17 16:36:08 +01:00
Contributor
Copy Link

added comments for menu handlers methods.

added comments for menu handlers methods.
lash requested changes 2024-12-18 07:37:48 +01:00
Dismissed
lash left a comment
Owner
Copy Link

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.
👍 1
internal/handlers/ussd/menuhandler.go Outdated
@@ -80,6 +80,7 @@ type Handlers struct {
profile *models.Profile
}
// Creates a new instance of Handlers
lash commented 2024-12-18 07:36:50 +01:00
Owner
Copy Link

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 ..."
👍 1
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
Dismissed
lash left a comment
Owner
Copy Link

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

please let's also add punctuation for all comment sentences.
internal/handlers/ussd/menuhandler.go Outdated
@@ -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
lash commented 2024-12-19 09:58:36 +01:00
Owner
Copy Link

@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.
carlos commented 2024-12-22 06:18:09 +01:00
Member
Copy Link

@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.
internal/handlers/ussd/menuhandler.go Outdated
@@ -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
lash commented 2024-12-19 10:00:35 +01:00
Owner
Copy Link

Can this be more precise please?

Can this be more precise please?
internal/handlers/ussd/menuhandler.go Outdated
@@ -1957,6 +1984,7 @@ func (h *Handlers) ViewTransactionStatement(ctx context.Context, sym string, inp
return res, nil
}
// insertProfileItems handles bulk updates of profile information
lash commented 2024-12-19 10:01:18 +01:00
Owner
Copy Link

function name is not needed for unexported symbols.

function name is not needed for unexported symbols.
konstantinmds force-pushed dev/issue-205 from d946dfc577 to 21b24e0dbb 2024-12-23 10:29:32 +01:00 Compare
konstantinmds requested review from lash 2024-12-23 10:31:17 +01:00
konstantinmds force-pushed dev/issue-205 from 21b24e0dbb to c29cf4029a 2024-12-25 15:55:09 +01:00 Compare
konstantinmds force-pushed dev/issue-205 from c29cf4029a to f4f4fdd3ac 2024-12-25 16:00:22 +01:00 Compare
lash approved these changes 2024-12-27 12:57:54 +01:00
lash merged commit 813b92af78 into master 2024-12-27 12:58:01 +01:00
Sign in to join this conversation.
Reviewers
No Reviewers
lash
Labels
Clear labels
Compat/Breaking
Breaking change that won't be backward compatible
 Kind/Bug
Something is not working
 Kind/Documentation
Documentation changes
 Kind/Enhancement
Improve existing functionality
 Kind/Feature
New functionality
 Kind/Security
This is security issue
 Kind/Testing
Issue or pull request related to testing
Priority
Critical
The priority is critical
Priority
High
The priority is high
Priority
Low
The priority is low
Priority
Medium
The priority is medium
Reviewed
Confirmed
Issue has been confirmed
Reviewed
Duplicate
This issue or pull request already exists
Reviewed
Invalid
Invalid issue
Reviewed
Won't Fix
This issue won't be fixed
Status
Abandoned
Somebody has started to work on this but abandoned work
Status
Blocked
Something is blocking this issue or pull request
Status
Need More Info
Feedback is required to reproduce issue or to continue work
Activity
Doing
An item actively being worked on currently
Activity
Hold
Not being actively worked on
Activity
Proposal
A proposal for a new feature or enhancement
Activity
QA
Ready for QA testing
Activity
Validate
Dev team validating changes
Runner
AT
Runner
CLI
Runner
HTTP
Runner
SSH
cleanup
devops
documentation
easypeasy
A task that can be completed with little effort
 exchange
relating to swapping of assets and offramps
 i18n
Languages and translations
 legacy
Legacy features from the old ussd system to be ported
 meta
container for other issues
 migration
optimization
privilege
features that have to do with special, privileged axx
 refactor
smell
Code smell
 support
transparency and help with exception states
 tooling
ux
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
Alfred-mk carlos kamikazechaser lash willruddick
No Assignees
3 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: urdt/ussd#218
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?