All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Akira Yokosawa <akiyks@gmail.com>,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH v3 14/15] docs: conf.py: several coding style fixes
Date: Sun, 22 Jun 2025 23:41:09 +0200	[thread overview]
Message-ID: <20250622234109.1aecc840@foz.lan> (raw)
In-Reply-To: <87zfdza43l.fsf@trenco.lwn.net>

Em Sun, 22 Jun 2025 14:55:26 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:
> 
> > conf.py is missing a SPDX header and doesn't really have
> > a proper python coding style. It also has an obsolete
> > commented LaTeX syntax that doesn't work anymore.
> >
> > Clean it up a little bit with some help from autolints
> > and manual adjustments.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> > ---
> >  Documentation/conf.py | 351 +++++++++++++++++++++---------------------
> >  1 file changed, 172 insertions(+), 179 deletions(-)  
> 
> This file is definitely getting out of hand...:)

Yes. I almost removed all commented code to make it a little more
palatable.

> I notice a lot of the changes are just from 'single quotes' to "double
> quotes".  That adds a lot of churn; is there a reason for it?

Those churns are from black/autopep8, which also addressed other 
coding style issues(*).

I don't mind much about using either single or double quote, but
having a standard is a good thing. At the plus side, as C uses 
double quotes for strings this is closer to the kernel coding style.

So, I opted to merge such changes from the lint tools.

(*) I didn't blidnly accept all coding style changes from linters,
    dropping the ones that would make the final code worse.

Thanks,
Mauro

  reply	other threads:[~2025-06-22 21:41 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-22  6:02 [PATCH v3 00/15] Some improvements and fixes for the doc build system Mauro Carvalho Chehab
2025-06-22  6:02 ` [PATCH v3 01/15] docs: conf.py: properly handle include and exclude patterns Mauro Carvalho Chehab
2025-06-22  6:02 ` [PATCH v3 02/15] docs: Makefile: disable check rules on make cleandocs Mauro Carvalho Chehab
2025-06-22  6:02 ` [PATCH v3 03/15] scripts: scripts/test_doc_build.py: add script to test doc build Mauro Carvalho Chehab
2025-06-22  6:02 ` [PATCH v3 04/15] scripts: test_doc_build.py: make capture assynchronous Mauro Carvalho Chehab
2025-06-22  6:02 ` [PATCH v3 05/15] scripts: test_doc_build.py: better control its output Mauro Carvalho Chehab
2025-06-22  6:02 ` [PATCH v3 06/15] scripts: test_doc_build.py: better adjust to python version Mauro Carvalho Chehab
2025-06-22  6:02 ` [PATCH v3 07/15] scripts: test_doc_build.py: improve dependency list Mauro Carvalho Chehab
2025-06-22  6:02 ` [PATCH v3 08/15] scripts: test_doc_build.py: improve cmd.log logic Mauro Carvalho Chehab
2025-06-22  6:02 ` [PATCH v3 09/15] scripts: test_doc_build.py: make the script smarter Mauro Carvalho Chehab
2025-06-22  6:02 ` [PATCH v3 10/15] scripts: sphinx-pre-install: properly handle SPHINXBUILD Mauro Carvalho Chehab
2025-06-22  6:02 ` [PATCH v3 11/15] scripts: sphinx-pre-install: fix release detection for Fedora Mauro Carvalho Chehab
2025-06-22  6:02 ` [PATCH v3 12/15] scripts: test_doc_build.py: regroup and rename arguments Mauro Carvalho Chehab
2025-06-22  6:02 ` [PATCH v3 13/15] docs: sphinx: add a file with the requirements for lowest version Mauro Carvalho Chehab
2025-06-22  6:02 ` [PATCH v3 14/15] docs: conf.py: several coding style fixes Mauro Carvalho Chehab
2025-06-22 20:55   ` Jonathan Corbet
2025-06-22 21:41     ` Mauro Carvalho Chehab [this message]
2025-06-22  6:02 ` [PATCH v3 15/15] docs: conf.py: Check Sphinx and docutils version Mauro Carvalho Chehab
2025-06-22 11:19   ` Akira Yokosawa
2025-06-22 17:53     ` Mauro Carvalho Chehab
2025-06-22 18:06     ` Mauro Carvalho Chehab
2025-06-22 20:58     ` Jonathan Corbet
2025-06-22 21:50       ` Mauro Carvalho Chehab
2025-06-25 18:37         ` Jonathan Corbet
2025-06-25 20:18           ` Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250622234109.1aecc840@foz.lan \
    --to=mchehab+huawei@kernel.org \
    --cc=akiyks@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.