fontforge / fontforge.github.io

The FontForge homepage
http://fontforge.github.io/
107 stars 44 forks source link

Fix word repetion in all the docs #147

Closed tetedacier closed 4 years ago

tetedacier commented 4 years ago

Those has been found thanks to the execution accross all the docs of this rudimentary regex: \b([^\s\d]{2,5})\s+\1\b

It is inspired from the the one described by Jeffrey Friedl in his book Mastering Regular Expression.

frank-trampe commented 4 years ago

@tetedacier, thanks for doing this. I've marked up a few details that seemed off. Before you do anything else, though, I want to have a quick discussion about which pages we consider historical monuments rather than working documents. @ctrlcctrlv, what do you think?

jtanx commented 4 years ago

This is probably better fixed in the fontforge repo itself, the non-archived stuff will be overwritten the next time we push updates back here

frank-trampe commented 4 years ago

@jtanx, good catch!

tshinnic commented 4 years ago

Sorry, and I'll stop with the comments. I think I've demonstrated that while many of these proposed changed are valid, about 1 in 4 or 5 are not. Not noticing that some of these files were changelogs is disturbing. Reaching into non-English texts where the uncertainty is multiplied, likewise. And HTML comments... zounds!

How could this have been better accomplished, starting from a raw unreviewed and dangerous output?

jtanx commented 4 years ago

Some good points raised, but I'm closing this to avoid further confusion - the documentation is generated from Sphinx/rst files in the main fontforge/fontforge repo, and I don't think it's worth bothering to update the archived documentation at this point (it's archived!!!).

If you'd like to make improvements, please update the files under https://github.com/fontforge/fontforge/tree/master/doc/sphinx instead.

tetedacier commented 4 years ago

Firstly, I’d like to thanks all of you for all your reviews, I learned a lot from all of them.

By the way, I’ve made the mistake described in this PR title in the second sentence of my comment :man_facepalming: lack of sleep makes me weak and less focused …

@tshinnic: I did’t apply my regex automatically, it was just a guide, I still have 1555 matches of this pattern which mainly concern html class attributes :smile: another reason for my lack of focus on the meaning of impacted sentences.

@jtanx: I get your point, and will back port relevant and reviewed change in fontforge main repository if nobody has already done it.

@jtanx, @tshinnic: I’m thinking about a smart way to handle this archive issue (lots of old folder are here for inner archive references) directly in git. I will let you know in the issues tracker.

Cheers !