[next-major] Remove traces of CamelCase
まだ誰も着手していません。
評価
調査の方向性
issue に示されている Python wrapper の宣言から始め、writer、suggestion、search API に残っている CamelCase 名を見つけます。公開されているそれらのメソッドとパラメーターを snake_case に変更し、関連する命名例外を削除して、次のメジャーリリース前に参照とチェックが新しい API を使用していることを確認します。
索引モデルが issue の本文から書いたものです。
説明
As libzim uses CamelCase, we sometimes followed the convention to stick to the pure-wrapper way.
Given case is not that important and we don't follow it everywhere (it's become minor overtime), we should just remove the remaining traces and use snake case everywhere.
It's a tiny change but obviously breaks the API so should not be merged until approaching next major release
# writer
def config_nbworkers(self, nbWorkers: int) -> Self: ... # noqa: N803
def set_mainpath(self, mainPath: str) -> Self: ... # noqa: N803
def add_redirection(
self,
path: str,
title: str,
targetPath: str, # noqa: N803
hints: dict[Hint, int],
) -> None: ...
def add_alias(
self,
path: str,
title: str,
targetPath: str, # noqa: N803
hints: dict[Hint, int],
) -> None: ...
# suggestion
def getEstimatedMatches(self) -> int: ... # noqa: N802
# search
def getEstimatedMatches(self) -> int: ... # noqa: N802
def getResults(self, start: int, count: int) -> SearchResultSet: ... # noqa: N802
- 主要言語
- Python
- スター
- 109
- フォーク
- 29
- 平均マージ
- 9日 1時間
- マージ済み PR(30日)
- 1
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
openzim/python-libzim のほかの issue
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
openzim/python-libzim#268 · コメント 4 件 · リアクション 1 件 ·
-
Release 3.14.0 オープンtask
openzim/python-libzim#267 · 担当者 1 名 ·
-
Code review: writer-path use-after-free, sys.modules corruption, GIL held across all reader I/O オープン
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
openzim/python-libzim#266 ·
-
Build for ABI3 オープンenhancement
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
openzim/python-libzim#264 · コメント 1 件 ·
-
enhancement upstream
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
openzim/python-libzim#241 ·
openzim/python-libzim の issue をすべて見る
似ている issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
stephrobert/dsoxlab#238 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
sublimehq/package_control#1780 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
nwg-piotr/nwg-displays#145 ·