Is There Any Way to Disable Error Highlighting in Github?

Question

Github highlights the second % in this line as an error:

fscanf(fp, "%d%*[^\n]\n", &ints[i]);

However, the code compiles perfectly and the removing the 'error' will cause the program to function incorrectly.
Is there any way to either disable this error highlighting or make Github recognize it as correct?

VonC · Accepted Answer · 2017-08-14T11:27:31.670

3

Update: pchaigno points out in the comments the section linguist#Overrides, where you can use for instance .gitattributes:

Add a .gitattributes file to your project and use standard git-style path matchers for the files you want to override to set linguist-documentation, linguist-language, linguist-vendored, and linguist-generated. .gitattributes will be used to determine language statistics and will be used to syntax highlight files. You can also manually set syntax highlighting using Vim or Emacs modelines.

$ cat .gitattributes
*.rb linguist-language=Java

Original Answer Jan. 2017

Since you cannot easily remove the GitHub highlight, you can try and use a similar workaround I suggested in "How to fix/ignore syntax error in github"

Try and add on the same line a comment with a '%' in it, in order for the lexer (used by the syntax highlighting engine Rouge and Pygment) to not propagate the "error" to all subsequent lines.

edited Aug 14 '17 at 11:27

answered Jan 12 '17 at 05:32

VonC

1,262,500
529
4,410
5,250

Thank you for the suggestion, but this method does not appear to change it for me. – parallel_resistance Jan 12 '17 at 07:00
@parallel_resistance it usually requires a few attempts before finding the right character or sequence which would close the "error" detected by the lexer. – VonC Jan 12 '17 at 07:18
Okay, I already tried `//%` and `//%d`, so I'll mess around with it more tomorrow. – parallel_resistance Jan 12 '17 at 07:25
@VonC This answer would need to be updated; it is now possible to disable syntax highlighting thanks to [Linguist overrides](https://github.com/github/linguist#overrides). – pchaigno Aug 14 '17 at 11:02
@pchaigno Thank you . I have edited the answer accordingly. – VonC Aug 14 '17 at 11:27

score 1 · Answer 2 · answered Aug 14 '17 at 11:08

To complete VonC's answer, if you think the highlighting is incorrect, you can actually file a bug report or even fix it; All grammars github.com uses are open source!

How to find the grammar? To find the grammar used for syntax highlighting in your case, you can visit this page on the Linguist project. In front of each language (looks like C in your case), you'll find the repository where the grammar for that language lives (for C, github.com/textmate/c.tmbundle). You can open an issue there with your failing test case, or even better, try and fix it yourself.

Is There Any Way to Disable Error Highlighting in Github?

2 Answers2