{"action":"created","issue":{"url":"https://api.github.com/repos/rurema/doctree/issues/1579","repository_url":"https://api.github.com/repos/rurema/doctree","labels_url":"https://api.github.com/repos/rurema/doctree/issues/1579/labels{/name}","comments_url":"https://api.github.com/repos/rurema/doctree/issues/1579/comments","events_url":"https://api.github.com/repos/rurema/doctree/issues/1579/events","html_url":"https://github.com/rurema/doctree/issues/1579","id":379419682,"node_id":"MDU6SXNzdWUzNzk0MTk2ODI=","number":1579,"title":"不要な空白がドキュメントの文章内に頻出している","user":{"login":"r7kamura","id":111689,"node_id":"MDQ6VXNlcjExMTY4OQ==","avatar_url":"https://avatars2.githubusercontent.com/u/111689?v=4","gravatar_id":"","url":"https://api.github.com/users/r7kamura","html_url":"https://github.com/r7kamura","followers_url":"https://api.github.com/users/r7kamura/followers","following_url":"https://api.github.com/users/r7kamura/following{/other_user}","gists_url":"https://api.github.com/users/r7kamura/gists{/gist_id}","starred_url":"https://api.github.com/users/r7kamura/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/r7kamura/subscriptions","organizations_url":"https://api.github.com/users/r7kamura/orgs","repos_url":"https://api.github.com/users/r7kamura/repos","events_url":"https://api.github.com/users/r7kamura/events{/privacy}","received_events_url":"https://api.github.com/users/r7kamura/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":7,"created_at":"2018-11-10T12:50:17Z","updated_at":"2018-11-12T03:58:59Z","closed_at":null,"author_association":"CONTRIBUTOR","body":"## 概要\r\n\r\n```\r\nオプションサマリには出てきません\r\n```\r\n\r\nのような文章が表示されることを期待している箇所で、\r\n\r\n```\r\nオプションサマリには 出てきません\r\n```\r\n\r\nのように不要な空白が配置されている、という事例がドキュメント内で多く見受けられ、これは意図されたものではないだろうと思い Issue を立てました。\r\n\r\n## 例\r\n\r\n例えば https://docs.ruby-lang.org/ja/latest/class/OptionParser.html を例にすると、以下の画像内で矢印を付けている箇所のことを指しています。\r\n\r\n![image](https://user-images.githubusercontent.com/111689/48301350-d3891480-e52f-11e8-8c7d-1d609cfee100.png)\r\n\r\n## 推測した理由\r\n\r\nなぜこうなっているのか調べたところ、ソースコード中に含まれている改行がそのまま HTML 内に出力されているため、Web ブラウザには空白のテキストノードとして扱われており、結果としてユーザには空白が見えているのではないかと考えました。\r\n\r\n![image](https://user-images.githubusercontent.com/111689/48301357-e7cd1180-e52f-11e8-8c24-3a598c06161a.png)\r\n\r\nこの部分の HTML は、以下のソースコードを元にして生成されたものだと思います。\r\n\r\nhttps://github.com/rurema/doctree/blob/5afe4dc14cfcb026ff3b271df49d4147f6f67e61/refm/api/src/optparse/OptionParser#L23-L24\r\n\r\n## 思いつく解決策\r\n\r\nこの Issue を立てた時点で思いついた解決策を二つ挙げてみます。\r\n\r\n~~個人的には案2は難しいと思っています。~~ (案1も結局機械的に変換するなら同じくらいの難易度ですね)\r\n\r\n### 案1\r\n\r\nソースコード内から、(日本語の単位としての) 行の中には改行を含めないように少しずつ変更していく。\r\n\r\n### 案2\r\n\r\nパーサの挙動を変更し、単一の改行を無視する (`\\n\\n` のように連続する改行だけ改行と見なす) ようにした上で、これによっておかしくなってしまった箇所を修正する。"},"comment":{"url":"https://api.github.com/repos/rurema/doctree/issues/comments/437745949","html_url":"https://github.com/rurema/doctree/issues/1579#issuecomment-437745949","issue_url":"https://api.github.com/repos/rurema/doctree/issues/1579","id":437745949,"node_id":"MDEyOklzc3VlQ29tbWVudDQzNzc0NTk0OQ==","user":{"login":"r7kamura","id":111689,"node_id":"MDQ6VXNlcjExMTY4OQ==","avatar_url":"https://avatars2.githubusercontent.com/u/111689?v=4","gravatar_id":"","url":"https://api.github.com/users/r7kamura","html_url":"https://github.com/r7kamura","followers_url":"https://api.github.com/users/r7kamura/followers","following_url":"https://api.github.com/users/r7kamura/following{/other_user}","gists_url":"https://api.github.com/users/r7kamura/gists{/gist_id}","starred_url":"https://api.github.com/users/r7kamura/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/r7kamura/subscriptions","organizations_url":"https://api.github.com/users/r7kamura/orgs","repos_url":"https://api.github.com/users/r7kamura/repos","events_url":"https://api.github.com/users/r7kamura/events{/privacy}","received_events_url":"https://api.github.com/users/r7kamura/received_events","type":"User","site_admin":false},"created_at":"2018-11-12T03:58:59Z","updated_at":"2018-11-12T03:58:59Z","author_association":"CONTRIBUTOR","body":"bitclust の実装にまだあまり詳しくないので、案3の内でどちらが良いかという意見は出せないんですが、\r\n\r\n- ソースコードには改行を挿れられるほうが編集しやすい\r\n- 不完全な Web ブラウザのための対応である\r\n\r\nということで、自分も案3に賛成です。"}}
{"actor":{"display_login":"r7kamura"}}