Improve comment about the "ED" tile bug #421
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
|
Why remove it? |
@Rangi42 said "No comment, no official doc" when I asked her about this type of comment a while back. |
|
I see no reason to remove the recording of this information. Even ignoring flawed emulators, this information is relevant to anyone who tries to move the graphic to any bank other than bank 0 or bank 1. If anything, the comment should elaborate even more.. |
|
Would a wiki tutorial be a suitable alternative? |
|
I don't think so. I think inline in source is good. |
|
If you really want this documented, the actual code line should be explicit about why it's "wrong": |
SatoMew
changed the title
|
Sounds good! 😃 |
|
Yeah, I like that better 👍 |
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.
This workaround was added as a comment in commit 8a6d46f.