Fix overviews' example code warnings by using fenced code blocks #229
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
It needs appledoc v2.2.1 (build 1334), which can be found here: tomaz/appledoc#535
|
Looks good. r=me |
jwe-apple
added a commit
that referenced
this pull request
May 27, 2015
Fix overviews' example code warnings by using fenced code blocks
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.
I have submitted an appledoc pull request which allows us to fix the spurious cross reference warnings in the sample code blocks within the overview markdown documents.
This ResearchKit pull request makes the sample code in the markdown overviews fenced code blocks (these don't interfere with the current appledoc version either), and removes the echo warnings in the docs building script.
If you update to appledoc v2.2.1 (build 1334) (find it in the above PR) and merge this, the warnings when building the documentation will be gone.