EPICS Controls Argonne National Laboratory

Experimental Physics and
Industrial Control System

2002  2003  2004  2005  2006  2007  2008  2009  2010  2011  2012  2013  2014  2015  2016  2017  2018  2019  <20202021  2022  2023  2024  Index 2002  2003  2004  2005  2006  2007  2008  2009  2010  2011  2012  2013  2014  2015  2016  2017  2018  2019  <20202021  2022  2023  2024 
<== Date ==> <== Thread ==>

Subject: Re: Document builds on readthedocs (lesson I learned)
From: "Johnson, Andrew N. via Core-talk" <core-talk at aps.anl.gov>
To: EPICS core-talk <core-talk at aps.anl.gov>
Date: Tue, 7 Apr 2020 16:22:22 +0000
I was also getting ligatures in some of the Codeathon PRs that added Doxygen annotations. Presumably Doxygen accepts them or the PR's author would probably have noticed. One of the text editors I use (nedit-ng) can’t handle UTF-8 or multibyte characters at all, so they stick out pretty easily there and I have been replacing them as I merge the PRs. Another way to find them might be to pick an editor font that doesn’t have the necessary glyphs for the ligatures, so when they get displayed they are shown in a different font and look different.

- Andrew


On Apr 7, 2020, at 11:05 AM, Timo Korhonen via Core-talk <core-talk at aps.anl.gov> wrote:

Thanks Martin, that tool would have been nice to have but I did not know.

I converted html-files to rst and I just saw now that the ligatures were in the html already.
One is always wiser afterwards but of course I should have checked. Next time I know.

I have to think about the pre-commit hooks; at the moment I have no idea if and how it would be possible in the readthedocs context.

Cheers,

Timo

On 07/04/20 17:08, "Konrad, Martin" <konrad at frib.msu.edu> wrote:

   Hi Timo,
Finally I was able to track the reason to pdflatex producing too many
errors because it could not handle “ligatures” in the UTF-8 files.
   Yeah, LaTeX doesn't want you to use ligatures in the source. It will of
   course automatically use them in the output to improve readability. So
   whenever you are copying text from a LaTeX-generated PDF file into your
   source you run into this problem.

   Here is a Python solution [1] that might help with replacing them. Would
   it make sense to turn that into a Git pre-commit hook? This would also
   give us the opportunity to run additional style checks in the future
   (e.g. prevent users from committing files with spaces at the end of a
   line etc.). The downside of pre-commit hooks is that they aren't copied
   automatically when cloning a repo.

   -Martin

   [1] https://stackoverflow.com/a/9175406/7583635

   --
   Martin Konrad
   Facility for Rare Isotope Beams
   Michigan State University
   640 South Shaw Lane
   East Lansing, MI 48824-1321, USA
   Tel. 517-908-7253
   Email: konrad at frib.msu.edu



-- 
Complexity comes for free, simplicity you have to work for.


References:
Re: Document builds on readthedocs (lesson I learned) Konrad, Martin via Core-talk
Re: Document builds on readthedocs (lesson I learned) Timo Korhonen via Core-talk

Navigate by Date:
Prev: Re: Document builds on readthedocs (lesson I learned) Timo Korhonen via Core-talk
Next: Build failed in Jenkins: epics-base-7.0-win64-test #154 APS Jenkins via Core-talk
Index: 2002  2003  2004  2005  2006  2007  2008  2009  2010  2011  2012  2013  2014  2015  2016  2017  2018  2019  <20202021  2022  2023  2024 
Navigate by Thread:
Prev: Re: Document builds on readthedocs (lesson I learned) Timo Korhonen via Core-talk
Next: Jenkins build became unstable: epics-pva2pva-linux32 #172 APS Jenkins via Core-talk
Index: 2002  2003  2004  2005  2006  2007  2008  2009  2010  2011  2012  2013  2014  2015  2016  2017  2018  2019  <20202021  2022  2023  2024 
ANJ, 07 Apr 2020 Valid HTML 4.01! · Home · News · About · Base · Modules · Extensions · Distributions · Download ·
· Search · EPICS V4 · IRMIS · Talk · Bugs · Documents · Links · Licensing ·