Update outdated documentation for BitmapFrontEnd. #3313
Merged
Conversation
This file contains 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
Contributor
glintfishGH
commented
Dec 11, 2024
glintfishGH
commented
- Changed arguments to start with a lowercase letter.
- Fixed documentation ported over from flash(?), where the documented @:params would not align to function arguments.
- Changed arguments to start with a lowercase letter. - Fixed documentation ported over from flash(?), where the documented @:params would not align to function arguments.
|
Oh I just merged this, thinking it was you |
Geokureli
requested changes
Dec 11, 2024
Co-authored-by: George Kurelic <Gkurelic@gmail.com>
Co-authored-by: George Kurelic <Gkurelic@gmail.com>
Co-authored-by: George Kurelic <Gkurelic@gmail.com>
Co-authored-by: George Kurelic <Gkurelic@gmail.com>
Co-authored-by: George Kurelic <Gkurelic@gmail.com>
Co-authored-by: George Kurelic <Gkurelic@gmail.com>
|
For future reference, where are the doc rules? didn't even know they existed |
|
lol they aren't formally listed anywhere. I should make that |
Geokureli
requested changes
Dec 12, 2024
| @@ -114,7 +114,7 @@ class BitmapFrontEnd | |||
| /** | |||
| * Check the local bitmap cache to see if a bitmap with this key has been loaded already. | |||
| * | |||
| * @param Key The string key identifying the bitmap. | |||
| * @param Key The key identifying the bitmap. | |||
There was a problem hiding this comment.
- make
keylower case - put 2 spaces after
keyand 3 before (currently a tab)
There was a problem hiding this comment.
FYI You resolved this without making the requested changes
Co-authored-by: George Kurelic <Gkurelic@gmail.com>
|
whoops, forgot that @ also tags people. |
Geokureli
approved these changes
Dec 12, 2024
lol, didn’t know someone had that GitHub name |
|
Thanks! |
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.