Add documentation for icon_names module#533
Draft
Lang-Qiu wants to merge 1 commit into
Draft
Conversation
Member
|
Since you placed this in draft mode, I'm not sure if you want any comments yet ;) Good catch, thanks! Before you submit the PR, please double check the line break style, this PR replaces LF with CRLF on 5 lines. We should only use LF -- and I realise we should have configured that via rustfmt.toml. |
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.
Problem Background
The public module
icon_namesinsrc/icons/mod.rslacked documentation, making it harder for users to understand its purpose and usage within the Satty application. This could lead to confusion for contributors and users trying to utilize icon name constants.Changes Made
icon_namesmodule to clearly describe its purpose: "Module containing generated icon name constants for use in the application."Verification