docs: add docstrings to list_user_courses.rs#234
Open
Majormaxx wants to merge 1 commit intoSkillCert:mainfrom
Open
docs: add docstrings to list_user_courses.rs#234Majormaxx wants to merge 1 commit intoSkillCert:mainfrom
Majormaxx wants to merge 1 commit intoSkillCert:mainfrom
Conversation
Added comprehensive docstrings following the project template to: - `list_user_courses` function with description, arguments, and return value - `test_list_user_courses` test function with description Closes SkillCert#203
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds comprehensive docstrings to all functions in
contracts/course/course_access/src/functions/list_user_courses.rs, following the project's documentation template as specified in issue #203.Changes
list_user_coursesfunctionAdded documentation including:
env- The Soroban environment contextuser- The blockchain address of the userUserCoursesstruct returnedtest_list_user_coursestest functionAdded documentation describing the test's purpose and what it verifies.
Documentation Format
All docstrings follow the required template:
Checklist
Closes #203