search

gliese581gg / YOLO_tensorflow

tensorflow implementation of 'YOLO : Real-Time Object Detection'
Other
1.72k stars 656 forks source link

Fix broken headings in Markdown files #25

Closed bryant1410 closed 6 years ago

bryant1410 commented 7 years ago

GitHub changed the way Markdown headings are parsed, so this change fixes it.

See bryant1410/readmesfix for more information.

Tackles bryant1410/readmesfix#1

akanimax commented 6 years ago

Lol! That was the first thought that came to my mind when I landed on this repository. I wonder why your pull request hasn't been merged yet. Not related, but is there any open source project (more like a script) that performs the readme parsing and fixes the errors if any? If not, it could be a good project. I have come across many such broken readmes recently

bryant1410 commented 6 years ago

I think that a general tool that fixes any error is somewhat impossible, the fix should be known somewhat.

For example, if I tell you something related to the "Monday, November 21th", did I meant "Tuesday" or "22th"? If there are generic parsing errors in Markdown, it would be hard to fix them. I made this tool just to fix this particular error, which came from a GH change.

akanimax commented 6 years ago

That is what I meant. Correcting the semantic errors is impossible for any system. I was hinting at a tool that could at least highlight possible syntactic errors in the Readme Markdown. Seems like you have already made it :+1: . Star to you!

adyavanapalli commented 6 years ago

Please merge this soon, @gliese581gg.