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

GoDocでの全角文字使用時の見出し文字の制限について #15

Open
inatus opened this issue Jan 26, 2014 · 19 comments
Open
Labels

Comments

@inatus
Copy link
Contributor

inatus commented Jan 26, 2014

GoDocで見出し文字として表示される条件は、どうやら以下のようです。

  • 直前に改行文字が2つ続けて入っている
  • 半角英字の大文字で始まっている

下記でも全角文字および半角英字の小文字で始まっている見出しは、通常のテキストとして表示されてしまいました。
http://godoc.org/github.com/gophersjp/go/src/cmd/go

対策のしようがないと思いますが、一応上げておきます。

@atotto
Copy link
Member

atotto commented Jan 26, 2014

そういえばそうでした。私もこれでわざと見出しを翻訳しなかったのを思い出しました。。
http://godoc.org/github.com/gophersjp/go/src/cmd/gc

日本語で戦うのであればここのメソッドを修正する必要がありそうですね。
http://golang.org/pkg/go/doc/#ToHTML
http://golang.org/src/pkg/go/doc/comment.go?s=6479:6541#L248

@inatus
Copy link
Contributor Author

inatus commented Feb 8, 2014

修正してみました。
こんな感じでしょうか。

@atotto
Copy link
Member

atotto commented Feb 10, 2014

ローカルで試してみました。いい感じですね!

ただ、もともとのテスト(comment_test.go)の中身が消えちゃってるので、
src/pkg/go/doc/comment_test.go を src/pkg/go/doc/comment_japanese_test.go とするか、マージしたほうが良いと思います。
もともとのテストも同時に走らせましたがパスしたので問題なさそうです。

これって、goの本家に反映したりしないですか?

@inatus
Copy link
Contributor Author

inatus commented Feb 10, 2014

確認ありがとうございます!

ただ、もともとのテスト(comment_test.go)の中身が消えちゃってるので、
src/pkg/go/doc/comment_test.go を src/pkg/go/doc/comment_japanese_test.go とするか、マージしたほうが良いと思います。

すみません、ちゃんと見てませんでした。。。
comment_japanese_test.go に変更します。

これって、goの本家に反映したりしないですか?

なんらかの形で提案したいところですね。
コード(nonlatincharactersupport.go)を見ていただくとわかるのですが、
これだと言語が増えれば増えるほどパフォーマンスが落ちます。
doc.goのどこかに言語情報を埋め込む(たとえばドキュメントの冒頭に「// language: ja」と書く)などして、
その言語の判定だけをさせるようにしたほうがよいかなあ、とも思っています。
どうですかね。

@atotto
Copy link
Member

atotto commented Feb 11, 2014

たしかにパフォーマンスに影響しますね。
言語が増えることを想定すると言語情報を埋め込んでしまうのがいい気がします。

@inatus
Copy link
Contributor Author

inatus commented Feb 15, 2014

とりあえずできました。
コメントに1行目に
{"language": "ja"}
とJSONで書くと日本語のチェックがオンになります。

で、これ本家にあげるにはどうしたらいいんでしょうか。
Issueであげて既存ソースのパッチと追加のソースファイルを添付すればいいのでしょうか。。。

@atotto
Copy link
Member

atotto commented Feb 15, 2014

この場合どのルートがいいのか自分も不案内ですが、issueかgolang-nutsのメーリングリストですかねぇ。

ちなみに、ソースはcodereviewにアップしておけば手作業でパッチつくらなくて良いです。

コミット(codereview)に関する流れは http://godocjp.herokuapp.com/doc/contribute.html の通りですが、大まかな流れを書くと:

  • goのリポジトリをチェックアウト
  • hgにcodereviewの拡張設定を書く
  • 修正する
  • hg changeする
  • issue or メーリングリスト(golang-nuts)に投げる (hg mailはしない)

最後のissue or メーリングリストは最初に言っておくか最後にcodereviewのリンクまで貼って言うかはおまかせします(^^ゞ

@inatus
Copy link
Contributor Author

inatus commented Feb 15, 2014

あ、すみません、またちゃんと見てませんでした。
まずはメーリングリストで議論しろと書いてありますね。
とりあえず、トピックを上げてみます。

@inatus
Copy link
Contributor Author

inatus commented Feb 16, 2014

メーリスに投稿しました。
が、初投稿にはモデレータの認証が必要らしく、表示されるのに2,3時間かかりますと書いてあるのにまる一日経った今でもまだ表示されていません...
まだ休日なのでアメリカ時間の週明けまで待ってみます。

@inatus
Copy link
Contributor Author

inatus commented Feb 17, 2014

掲載されました。

https://groups.google.com/forum/#!topic/golang-nuts/lsMbGtl9e7k

が、なんかもうすでに埋もれてるんですが...

@atotto
Copy link
Member

atotto commented Feb 17, 2014

お、コメントついてますね。

@inatus
Copy link
Contributor Author

inatus commented Feb 17, 2014

issueをあげろとのことですね。
実現方式についてはissueの中で議論すればよいということですかね。
golang-nutsに書いたのと同様の内容であげときます。

@inatus
Copy link
Contributor Author

inatus commented Feb 18, 2014

issueあげました。

https://code.google.com/p/go/issues/detail?id=7349

@inatus
Copy link
Contributor Author

inatus commented Feb 22, 2014

外部の人からいくつかコメントがついてますね。
難クセつけてくる輩がいたのでうるせーと返しときました。

こんな感じで議論続けていったらそのうち中の人がacceptedにしてくれるんですかね...

@atotto
Copy link
Member

atotto commented Feb 22, 2014

さすがですw
長期戦になりそうですねぇ。
ひとまず今公開してるところにパッチするようにしましょうかね。。

@atotto atotto added the kaizen label Feb 22, 2014
@inatus
Copy link
Contributor Author

inatus commented Feb 23, 2014

そうですね!
いまのところブランチ切ってソース置いてるんですが、masterにマージしたほうがいいですか?

https://github.com/gophersjp/go/tree/issue/15

@inatus
Copy link
Contributor Author

inatus commented Feb 24, 2014

ちょっと動きがありましたね。
golangの中の人からコメントがありました。
go.textレポジトリのパッケージを使って実現したいとのことで、HelpWantedのステータスになりました。
とりあえずgo.textの中の人が降臨するのを待ちわびてればいいんですかね...

https://code.google.com/p/go/issues/detail?id=7349

@atotto
Copy link
Member

atotto commented Feb 24, 2014

ほぅ、 go.text https://code.google.com/p/go/source/browse/?repo=text ですか。
どんなふうになるんだろう・・

いま切ってあるブランチですが、ちょっとお待ちください。
ひとまず、drone.ioからherokuに渡すときにどうしたらうまく行くかを考えます。。

@inatus
Copy link
Contributor Author

inatus commented Feb 24, 2014

はい、encodingの中にjapaneseがありますけど、こういうのを使うんでしょうか。。。
降臨を待ちましょう。
ラインナップが日本語、韓国語、簡体字、繁体字だけなのがなんとも興味深いです。

ブランチについては了解しました。

inatus added a commit that referenced this issue Feb 27, 2014
… category L without lower case characters are valid #15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants