Ignore cross references inside markdown fenced code blocks #535
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
…ode blocks (``` code ```)
rsanchezsaez
added a commit
to rsanchezsaez/ResearchKit
that referenced
this pull request
May 26, 2015
It needs appledoc v2.2.1 (build 1334), which can be found here: tomaz/appledoc#535
tomaz
added a commit
that referenced
this pull request
Sep 8, 2015
Ignore cross references inside markdown fenced code blocks
|
Merged, thanks and sorry for being so late... |
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 change makes
GBCommentsProcessorto ignore cross references inside markdown fenced code blocks (code block, see GitHub Flavored Markdown documentation for details).This allows to workaround longstanding issues like #253 or #348 by making the sample code whose warnings you want to avoid a fenced block.
Particularly, this will allow to suppress warnings when generating docs for Apple's ResearchKit.
I don't think this causes any unintended side effect. All the unit tests continue to pass after this change.