Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

downloadクレートの名称をdownloaderにする #607

Closed
Hiroshiba opened this issue Sep 12, 2023 · 9 comments · Fixed by #648
Closed

downloadクレートの名称をdownloaderにする #607

Hiroshiba opened this issue Sep 12, 2023 · 9 comments · Fixed by #648

Comments

@Hiroshiba
Copy link
Member

内容

voicevox_coreクレートは、自身を意味するvoicevox_coreを名乗っていますが、downloaderはdownloadクレートになっています。
downloadクレートも自身を意味するdownloaderに変えたほうがわかりやすい気がしました。

Pros 良くなる点

クレート内容とクレート名が同じになる。
補助的な効果としてcargo -p downloadなど初学者にとってちょっと分かりにくいコマンドじゃなくなる。

Cons 悪くなる点

実現方法

クレート名を変更してREADMEなども変更。

その他

downloadコマンドの名称をdownloadからdownloaderにすべきかはちょっと分かりませんでした。
それでもいいと思うけれども変えるほどではないかも。

@Hiroshiba Hiroshiba added 機能向上 要議論 実行する前に議論が必要そうなもの labels Sep 12, 2023
@Hiroshiba
Copy link
Member Author

@qryxip さん、 @y-chan さん的にはどうでしょう・・・?

@y-chan
Copy link
Member

y-chan commented Sep 13, 2023

確かに、クレート名と本来の名前が合致していないので、変えちゃっていいのでは無いかなと思いました!
他所から依存されているライブラリではないですし、名称変更を行うのは特に問題は無いかなという感じです。

@qryxip
Copy link
Member

qryxip commented Sep 14, 2023

よいと思います。

@Hiroshiba Hiroshiba removed the 要議論 実行する前に議論が必要そうなもの label Sep 14, 2023
@Hiroshiba
Copy link
Member Author

タイトル変えておきます!
📝 docsのファイル名も変える必要がありそう。

@Hiroshiba Hiroshiba changed the title downloadクレートは名称をdownloaderにすべき? downloadクレートの名称をdownloaderにする Sep 14, 2023
@Hiroshiba
Copy link
Member Author

こちらやっちゃおうと思います!

@Hiroshiba
Copy link
Member Author

Hiroshiba commented Oct 16, 2023

@qryxip @y-chan
その他のとこに書いてたのですが、この際にdownload.exedownloader.exeにしてしまおうか迷ってます 😇

実行バイナリの名称は、何をするかではなく、何をするものなのかを書いた方が良いと思ってます。
例えば喋る機械の名称は「スピーカー」であり「スピーク」ではないし、インストールする実行ファイルは「インストーラー」であり「インストール」ではない。
ので、どちらかというと正しいのはdownloaderかなと。

ただ、破壊的変更するべきもののほどなのかが若干自信が無く・・・。
API側は0.15のタイミングで破壊的変更OKで進めているので、この際にやっちゃった方がいいかなと個人的には思ってます。
ちなみに置き換え作業の面では、全部downloaderにしちゃった方が間違えにくいと思います 😇

まあでもわりとどっちでもいいと思うので、意見いただいたら素直にそっちに倒そうかなと思います!

@qryxip
Copy link
Member

qryxip commented Oct 16, 2023

個人的にはバイナリ名はdownload(.exe)のままでよいのではと思っています。

"builder.sh"のような名前より"build.sh"の方が多数ですし、Windows/Unix両方において、バイナリ名は"コマンド名"と捉えた方がよいのではと思っています。

@Hiroshiba
Copy link
Member Author

なるほどです!
確かにこのバイナリがもっと物感がある(例えばguiがあるとか)んだったらダウンローダーの方が正しそうですが、これはコマンド感が強いのでUnixの慣習に倣ってdownload.exeでも良さそうに思いました。

今ドキュメントではdownlaodコマンド(あるいはdownload実行バイナリ)を指してダウンローダーと呼んでいてどっちやねんっていう感じなのですが、まあ引き続きその感じでドキュメントを書いていけば問題なさそうですかね。

@Hiroshiba
Copy link
Member Author

downloadコマンド(=download実行バイナリ)を指して「ダウンローダー」と呼ぶ形で良さそうに感じたので、そっちに合わせようと思います!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants