Define routine documentation format#1247
Open
emilyploszaj wants to merge 1 commit intoRangi42:10bit-movesfrom
Open
Define routine documentation format#1247emilyploszaj wants to merge 1 commit intoRangi42:10bit-movesfrom
emilyploszaj wants to merge 1 commit intoRangi42:10bit-movesfrom
Conversation
vulcandth
added
docs
Collaborator
|
Most of our routine comments are under the routine label. Is there a precedent for IDE's to read it above the label? |
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
2 participants
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 PR proposes a format for rigorous routine documentation and applies it to a bunch of high traffic routines. Let me know any thoughts you have on the formatting, it's not set in stone.
Additionally, a
fallthroughmacro has been added. All it does is validate that the fallthrough hasn't had code inserted, slightly more reasonable than a fallthrough comment.Once this has been discussed and merged, I'll be applying more documentation across high traffic routines in the codebase, particularly around 10bit move expansion. If it ends up being useful, we can think about porting it upstream to pokecrystal.