crystal-jp / introducing-crystal

『Introducing Crystal Programming Language』の原稿をまとめたリポジトリです
https://crystal-jp.github.io/introducing-crystal/
17 stars 3 forks source link

05-shards #21

Closed arcage closed 6 years ago

arcage commented 6 years ago

ひとまず,初稿です。

お気付きの点,間違った理解をしている点などありましたらご指摘いただけるとありがたいです。

レイアウト調整などが必要だと思いますし,ブロックの使い方についても検討が必要だと思っています。

なお,現状では RedPen の ValidationError はゼロにできていません。

コードブロック内の不正なシンボル周りの話は上がってしましたが,日本語まわりでも以下のような事例に遭遇しました。

  1. 「過去のバージョンである○○を使いたい」とか, 条件を列挙するリスト内での「〇〇である」辺りの「である」が引っかかる
  2. 「〇〇だった場合」の「だった」が引っかかる
  3. 「〇〇のための」で「の」が連続しているため引っかかる
  4. 「吠える」や「玉石混淆」が常用漢字でないためひっかかる
  5. セクション文字数が1500を超えるためひっかかる セクションを分割しようとすると階層が深くなります

これらについても対応の上,ValidationError ゼロを目指すべきでしょうか?

5t111111 commented 6 years ago
  1. 「過去のバージョンである○○を使いたい」とか, 条件を列挙するリスト内での「〇〇である」辺りの「である」が引っかかる
  2. 「〇〇だった場合」の「だった」が引っかかる
  3. 「〇〇のための」で「の」が連続しているため引っかかる
  4. 「吠える」や「玉石混淆」が常用漢字でないためひっかかる
  5. セクション文字数が1500を超えるためひっかかる セクションを分割しようとすると階層が深くなります

僕も結構ひっかかって (特に 14)、自分のは何とか直せるレベルだったので対応しましたけど、こちらチェックしてみると本文の分量が多いのもあってかなり引っかかりますね…

どうしましょうかね @MakeNowJust

もうあまりに予定の締め切りには時間がないので、上記に関しては RedPen の config で

<validator name="Hoge" level="warn" />

とした上で、執筆中には各自なるべく

redpen -t warn -c config/redpen/conf.xml -L ja index.adoc 01-introduction/content.adoc 02-getting-started/content.adoc 03-syntax/content.adoc 04-macro/
content.adoc 05-shards/content.adoc 06-tools/content.adoc 07-web-development/content.adoc 08-cli-development/content.adoc 09-history/content.adoc 2>/dev/null

とかを実行して確認してもらう、とかの運用でカバーでいくくらいでもいいかなーと

makenowjust commented 6 years ago

常用漢字に関しては明らかに無用な気がするので無効にしてしまってもいい気がします。

「だった場合」の「だった」は原則として「の」に置き換えられると思うので、それで直してください。

他はすぐには直せなさそうなので、とりあえず「Warn」に下げて対応でいい気がします。

arcage commented 6 years ago

あの後なんとか,「不正なシンボル」以外のValidationErrorをほぼ回避するように手を入れてみました。

ただ,1箇所だけ

content.adoc:455: ValidationError[SuggestExpression], 不正な単語 "github" がみつかりました.かわりに "GitHub" を利用してください。 at line: 1. 何箇所かある your-github-name を自分の GitHub アカウントに置き換える

だけは,引用元がこの表記なのでいかんともしようがありません。

arcage commented 6 years ago

あ,常用漢字「吠」「淆」は使って良ければ戻したいです。 なんとなく間が抜けた感じになってしまって。

makenowjust commented 6 years ago

使って大丈夫です。というかJapaneseJoyoKanjiを無効にするPull Requestを出してもらえればマージします。

makenowjust commented 6 years ago

部分的に InvalidSymbol を無効にするのはここを参考にしてください。

https://github.com/crystal-jp/techbookfest4/pull/18/commits/c9e9dfa604d9e3179bf933c1f50d8462df30ac9e

arcage commented 6 years ago

InvalidSymbolと,1箇所だけ回避不能のSuggestExpressionを無効化しました。

make lint は通るようになりましたが,CircleCI側のmake testで落ちてますね。 libgmpを見つけられてないようですが,BigInt使ってる関係でしょうか。

手元の環境だと問題ないんですが。

makenowjust commented 6 years ago

多分そうですね。多分Dockerfileを修正する必要があるので、そのうち直します。

arcage commented 6 years ago

お手数おかけします。