search

dbgroup-nagoya-u / paper-lintrules

論文校正ツール
0 stars 0 forks source link

Apply rule to bibfile #113

Closed nrkt closed 3 years ago

nrkt commented 3 years ago

Resolve #92

github-actions[bot] commented 3 years ago

このPull Requestではtextlintが走ります:rocket: 適宜update.bashを使用してtextlintの設定を更新してください。

執筆の流れ

  1. 最初はReviewerを追加せず、このPull Requestで執筆と修正を続けてください。可能な限りtextlintが指摘を行います。
  2. 修正が完了し、Reviewerに添削をお願いできる状況になったら、 .github/workflows/textlint.ymlと.github/workflows/comment-open-pull-request.ymlを削除してください。 以降のcommitに対してはtextlintによる指摘が行われなくなります。
  3. commit後、一度このPull RequestをCloseしてください。ブランチはClose後も残るため、作業内容はGitHubに保存されています。
  4. Reviewerを追加する際は同じブランチ（通常はdevelop）をもとに別のPull Requestを作成し、そこでReviewを開始してください。
    • Review commentの数が100に近づくとページの表示が重くなります。 Textlintの修正が多い場合・Review前にはPull Requestを切り替えると快適に作業ができます。

バグ報告

おかしな指摘・指摘されていないが今後プログラムで指摘可能なルールを発見した場合は、 今後のためにこちらから指摘をお願いします:smiley:

執筆頑張ってください！

nrkt commented 3 years ago

@Yang-33 以下のようなことをやれたら良いかなと思うんですけど，何か意見を頂きたいです！

  1. \url{}の{}の中身を無視するようにする
    • 他の場合にも-を使いたい場合があるかわからない．
  2. bibファイル内の{\"e}のようなエラーを出さないようにする
    • latexでも使用する場合がありそう(参考)なのでルールを変える必要がありそう
Yang-33 commented 3 years ago

1も2も修正すれば動きそうという感じですね！確認ありがとうございます。 両方修正すればとりあえず動きそうなので該当箇所を修正してほしいです。

1の他の場合というのはとりあえず考えなくても良いです。誤検出してしまうのは論文や書籍のタイトル、URLぐらいだと思います。もし想定外の指摘がでてきたらそのとき一緒に考えましょう。とりあえず今回は上に書いてくれた通り\url{}内を無視するだけで良さそうです。

2の修正は{\"はダメで、"は良いと修正するだけで良さそう？

nrkt commented 3 years ago

bibファイルとtexファイルの2つのテストファイルがあってやや見にくいですが，チェックお願いします！