search

zverok / yard-junk

Get rid of the junk in your YARD docs
70 stars 3 forks source link

Wrong line number shown? #38

Open ChillerDragon opened 9 months ago

ChillerDragon commented 9 months ago 
main@debian:~/Desktop/git/teeworlds_network$ yard-junk 
Running YardJunk janitor (version 0.0.9)...

Problems
--------
mistyped tags or other typos in documentation

README.md:1: [InvalidLink] Cannot resolve link to msg.author.name from text: {msg.author.name}

0 failures, 1 problems (0 seconds to run)
main@debian:~/Desktop/git/teeworlds_network$ grep -n msg.author.name README.md 
24:  when 'whoami' then client.send_chat("You are: #{msg.author.name}")

It claims to have found an issue in line 1 of my readme but the line mentioned is line 24

zverok commented 4 months ago

Unfortunately, that’s probably how YARD reports it (you can check it if you’ll run YARD without yard-junk and look into error messages—most probably there would be no line number at all).

yard-junk just analyzes the errors YARD reports internally. Mentioned in Caveats here.