nikkie-ftnextの日記

イベントレポートや読書メモを発信

ドキュメントを1文字直し、私はCPythonのContributor!!

はじめに

君の夢が叶うのは 誰かのおかげじゃないぜ♪ nikkieです。

このたびCPythonリポジトリのContributorとなりました!
ドキュメントを1文字変えただけですが、CPythonに貢献できた!!

目次

その機会は突然やってきた

Python 3.11のtypingのドキュメント中に気になるところを見つけました。
https://docs.python.org/ja/3/library/typing.html#the-type-of-class-objects

a = 3         # Has type ``int```

コメントのintの右側だけバッククォートが3つなんですよ。
ドキュメントを通して2連バッククォートで囲んでいるようなんですが、ここだけ一貫していないことに気づいたのです。

今回の貢献はこの点についてpull requestを送ったというものになります

typo修正pull request

typoに気づいたら息をするようにやっているいつもの所作で送りました。
typo修正のpull requestは、ブラウザだけで送れるんです!

CPythonリポジトリのpull requestってissueとの関連がタイトルに明示されますが、

Trivial changes, like fixing a typo, do not need an issue.

とのこと1だったので、「これはtypo修正だからissueなし!」と堂々と送りました

やってみて驚かされたのは、スピード感!
10分でマージまで行きました。
ふつうに1日とか待つと思っていたので、「CPythonの開発ってすごい活発なんだな」と思い知らされました

感想(終わりにに代えて)

日頃お世話になっているCPythonに(1文字だけですが)貢献できて、冒頭の「君の夢が叶うのは 誰かのおかげじゃないぜ」が鳴り響いています。
日頃から気づいたtypoは(ライブラリの規模によらず)なるべくpull requestを送る(わずかでもみんなの資産を改善していく)という心持ちなのですが、この繰り返しが巡り巡って今回の機会をもたらしたように思います。

ぶっちゃけこんなのは1文字の変更なので全然大したことはないのですが、CPythonのContributorという肩書は憧れでもあったので、(記事を1本書いちゃうくらい)かなり嬉しいです!
嬉しい嬉しい嬉しい!!

イエェェェーイ!! やったぞおおおおお!!

これがきっと私の始まり(の1つ)。
ゆくゆくはもっと貢献できるよう、また1日1日を積んでいくのです

風の強い日を選んで 走ってきた♪

P.S. ふつう3連バッククォートに気づかなくない?

本文では経緯を端折っています。
まず日本語のドキュメントで2連バッククォートが紙面に出ている箇所を見つけたんですね。
https://docs.python.org/ja/3/library/typing.html#deprecated-aliases

これらは元々、``[]``を使ったジェネリッククラスの

typingのドキュメントで、マークアップされずに `` がそのまま出力されている · Issue #967 · python-doc-ja/python-doc-ja · GitHub として報告済みなのですが、起票するにあたって該当箇所をすべて洗い出したかったのです。
そこで日本語ドキュメント内を「``」で検索したところ、3連バッククォートのtypoに気づきました。
英語版にも3連バッククォートはあったので、pull requestを送った次第です。

3連バッククォートのtypoを見つけようとして見つけたわけでなく、他の事象の調査の中でたまたま芋づる式に見つかったのです。
今回は私、運がよかったんですよ!