Add more detailed inline documentation #97
Conversation
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
|
🔔 Friendly reminder: The following reviewers still need to review this PR: @ikethecoder PS: @sdqdadat |
4 similar comments
|
🔔 Friendly reminder: The following reviewers still need to review this PR: @ikethecoder PS: @sdqdadat |
|
🔔 Friendly reminder: The following reviewers still need to review this PR: @ikethecoder PS: @sdqdadat |
|
🔔 Friendly reminder: The following reviewers still need to review this PR: @ikethecoder PS: @sdqdadat |
|
🔔 Friendly reminder: The following reviewers still need to review this PR: @ikethecoder PS: @sdqdadat |
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.
Description
Types of changes
Adds improved inline Go documentation to help new developers understand methods and structs as needed, which is prominently displayed via LSPs in editors like Visual Studio Code (see screenshot). This includes the ability to add example code, links to specific files, etc.
Checklist
Further comments
See https://tip.golang.org/doc/comment for further details and examples of other documentation formatting that can be added in subsequent new code added to the repo.