Skip to content

Commit 756db96

Browse files
committed
expand on the style recommendation for dunder pronunciation
1 parent 0df75a7 commit 756db96

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

documentation/style-guide.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -229,12 +229,13 @@ Avoid first-person language. Our documentation is owned and maintained by a
229229
community. First-person language mistakenly implies a single author.
230230

231231

232-
Pronunciation of dunders
233-
========================
232+
Pronunciation of dunder names
233+
=============================
234234

235-
"Dunder methods" like ``__init__`` can be awkward in running prose: is it "an
236-
__init__" or "a __init__"? A `quick poll`__ indicates we should use
237-
"an __init__."
235+
"Dunder names" like ``__init__`` can be awkward in running prose: is it "an
236+
init" or "a dunder init"? Our recommendation is to ignore the underscores and
237+
use the article that is appropriate for the word in the name. A `quick poll`__
238+
backs this up: "an __init__."
238239

239240
__ https://hachyderm.io/@nedbat/112129685322594689
240241

0 commit comments

Comments
 (0)