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.

Sign up for GitHub

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

Jump to bottom

「ユーザー」のカタカナ表記を統一する #1839

Merged
merged 1 commit into from
May 5, 2022
Merged

「ユーザー」のカタカナ表記を統一する #1839

merged 1 commit into from
May 5, 2022

Conversation

sanomari
Copy link
Contributor

@sanomari sanomari commented May 3, 2022

PR の目的

タイトル通りです。

カテゴリ

  • リファクタリング
  • ドキュメント修正

PR の背景

#1822 で「ユーザー」の表記ゆれが指摘されました。

修正したい人がPRして良いということなのでPR作成します。

PR のメリット

PR のデメリット (トレードオフとかあれば)

仕様・動作説明

  • コメントやドキュメントにある「ユーザー」の表記を統一します。
  • 「ユーザーの利便性」を表す「ユーザビリティ」は置換対象から除外します。
  • VB用語「ユーザ定義型」は置換対象から除外します。

表記修正が目的であるため、静的解析の警告には対処しません。

PR の影響範囲

コメントとドキュメントに影響する変更です。
インストーラーの表示文言にも影響する変更です。

テスト内容

修正内容から不要と思います。

関連 issue, PR

参考資料

@sanomari
「ユーザー」のカタカナ表記を統一する
5fd700f 
コメントやドキュメントに現れる「ユーザー」のカタカナ表記を統一します。
「ユーザーにとっての利便性」を表す「ユーザビリティ」やVB用語「ユーザ定義型」は置換対象から除外します。
修正対象にissファイルが含まれるので、インストーラーにも影響する修正です。
@sanomari sanomari requested a review from a user May 3, 2022 07:39
@sanomari sanomari self-assigned this May 3, 2022
@sonarqubecloud
Copy link

sonarqubecloud bot commented May 3, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

100.0% 100.0% Coverage
0.0% 0.0% Duplication

@beru
Copy link
Contributor

beru commented May 3, 2022

おおむね問題無いと思いますが、以下のファイルについては変更を加えない方が良いかなと思います。

  • CHANGELOG.md
  • help/sakura/res/HLP_UR009.html
  • help/sakura/res/HLP_UR014.html
  • help/sakura/res/HLP_UR017.html

改版履歴の文言については変更をしない方が良いと思います。あくまで履歴用の記述なので現状の変更の対象外になるかなと思います。

ソースコード中にコメントで日付付きで誰々がどういう変更をしたかが書かれていますが、これについては変更対象としても構わないと思います（そもそもそういうコメントの付け方が時代遅れですが…）。いちいち判断するのは大変なので。

ghost
ghost suggested changes May 3, 2022
View reviewed changes
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

最終判断は一旦保留にします。
#1822 (comment)

@AppVeyorBot
Copy link

✅ Build sakura 1.0.4115 completed (commit c3f30453c7 by @sanomari)

@sanomari
Copy link
Contributor Author

sanomari commented May 3, 2022

変更履歴からヘルプが作られる場合も考えられるので、変更履歴も除外すべきでないと思います。

開発当時の状況をできる限り残したい意図なら、すでにGitリポジトリになっていることからオリジナルの履歴コメントを保持する意味はないように思います。

@beru
Copy link
Contributor

beru commented May 3, 2022 •
edited
Loading

変更履歴からヘルプが作られる場合も考えられるので、変更履歴も除外すべきでないと思います。

これはヘルプに変更履歴が含まれるとして、そこに表記ゆれがある状態を除外したいという事でしょうか？
別にサクラエディタを使う上で不都合は無いのだからそのままでも良いんじゃないですかね。

ただ仮に変更履歴の表記が多少変わったからと言って困る事も無いのでApproveします。

開発当時の状況をできる限り残したい意図なら、すでにGitリポジトリになっていることからオリジナルの履歴コメントを保持する意味はないように思います。

まぁヘルプに開発履歴を載せる意味はもう既に無いと思います。昔そうしていたから今もそうしているだけであって。

@Rukoto
Copy link
Contributor

Rukoto commented May 3, 2022

変更履歴やコード内のコメントまで含むかについては、ある意味「思い切って」含めることを推奨したいです。
含まなければ修正対応として中途半端になるとも言えるので、
根拠とかよりも「スマートである事」を好むか、という話なのかなと。
機能とは関係ない部分では、こういう対応もありうるのではないか、と思います。

小生は実際にプログラムを修正したり品質を担保する立場じゃないので、私がこれ以上申すことはございません。

@ghost
Copy link

ghost commented May 4, 2022

この内容で良いと思ったのでapproveに切り替えました。

@sanomari sanomari merged commit 5dfe2bc into sakura-editor:master May 5, 2022
@sanomari sanomari deleted the feature/fix_text_of_user branch May 5, 2022 05:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@beru beru beru approved these changes

Assignees

@sanomari sanomari

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@sanomari @beru @AppVeyorBot @Rukoto