The CR character was added for readability of output. But it makes the
texinfo writer a bit complicated. This removes it from output to keep
our code simple (reducing conditions).
The commit adds a new config value 'texinfo_emit_document_references'
that blocks the emission of inline references and make it better readable
with legacy stand-alone reader ``info``.
Before the change we emit:
Default option value for @ref{e,,-Wshift-overflow3}.
while with texinfo_emit_document_references == True:
Default option value for -Wshift-overflow3.
It addresses limitations mentioned in Sphinx' FAQ:
https://www.sphinx-doc.org/en/master/faq.html#texinfo-info
The following snippet:
Show :samp:`Samp with a {variable}.`
Ends in .info as:
Show ‘Samp with a `variable'.’
Which is suboptimal and @var{variable} should be rather used.
That results in ‘Samp with a VARIABLE.’.
Right now, labels are emitted as part of a @footnote directive.
That results in e.g.
Note1: (@footnote{@w{(1)}
Future versions of GCC may zero-extend...
})
which is incorrect and should be rather:
Note1: (@footnote{Future versions of GCC may zero-extend...})
Keep imports alphabetically sorted and their order homogeneous across
Python source files.
The isort project has more feature and is more active than the
flake8-import-order plugin.
Most issues caught were simply import ordering from the same module.
Where imports were purposefully placed out of order, tag with
isort:skip.
Since python3.5, subprocess.run() has been introduced. It works a
wrapper of Popen, and it looks much simple and better. This uses it
instead of Popen to make our code simple.
In Python 3, the default encoding of source files is utf-8. The encoding
cookie is now unnecessary and redundant so remove it. For more details,
see the docs:
https://docs.python.org/3/howto/unicode.html#the-string-type
> The default encoding for Python source code is UTF-8, so you can
> simply include a Unicode character in a string literal ...
Includes a fix for the flake8 header checks to stop expecting an
encoding cookie.
