Bug #778
継承元にしかドキュメントがないメソッドへのリンクを修正する
| Status: | Closed | Start date: | 11/23/2008 | |
|---|---|---|---|---|
| Priority: | Normal | Due date: | ||
| Assignee: |  Sho Hashimoto |
% Done: | 0% |
|
| Category: | doc:brokenlink | |||
| Target version: | - | |||
| reporter: | ruby_version: |
Description
以下のメソッドへのリンクは継承元にしかドキュメントがありません。 * Float#quo * refm/api/src/bigdecimal/BigDecimal * Float#remainder * refm/api/src/bigdecimal/BigDecimal * DateTime.parse * refm/api/src/parsedate.rd * DateTime.strptime * refm/api/src/parsedate.rd * Kernel.#clone * refm/doc/grossary.rd 直してしまえたらと思うのですが、過去に同様の問題を解決した例とかありますか？
Associated revisions
fix link (see #778)
add DateTime.parse, ._strptime, .strptime (see #778)
remove link (see #778)
History
Updated by okkez _ over 2 years ago
過去に同様の例を解決したことは無かったと思います。 * メソッドのリンクを修正する * メソッドエントリを追加する * 継承元にリダイレクトする という三つの修正方法が考えられます。 該当のメソッドが独立したエントリを持つべき強い理由が無いのであれば、メソッドのリンクを修正してしまうのがいいと思います。
Updated by Sho Hashimoto over 2 years ago
独立したエントリを持つべき強い理由はありません。ただ、読む人ができる限り違和感を持ちにくいものにする方が好ましいと考えています。 メソッドのリンクを修正するという事で想像したのが以下の2つの修正方法ですが、前者はメソッドによってリンクされるクラスが変化してしまうので、読みにくそうです。リンクではないだけなので読み飛ばせる後者の方がベターではないかと思います。 * 継承元にリンクする * リンクではなくす どうでしょう？なお、修正は私の方でやれたらと考えてます。
Updated by okkez _ over 1 year ago
- Category set to doc:brokenlink
- Status changed from Open to Assigned
- Assignee set to Sho Hashimoto
この件はどうなっていますか？ 作業していただけるとありがたいです。
Updated by Sho Hashimoto over 1 year ago
了解です。継承元にリンクを修正するようにしようかと思います。
Updated by Sho Hashimoto over 1 year ago
とても遅くなりましたが、上記の内 BigDecimal 以外は作業しました。 他にもいくつか対応していて、結局以下のような感じで作業しました。 * DateTime.parse, ._strptime, .strptime: 実は記述がないだけだったので追加 (r4261) * Float#to_s: 同上(r4245) * symref.rd: Integer#% => Fixnum#% にリンクを変更(r4244) * mathn.rd: リンクを削除(r4262) BigDecimal については、説明の中で Float が出てきそうなので、修正しませんでした。内容が追記された後でリンクがまだ切れてるようなら、別途チケットを発行させて頂こうかと考えています。 説明を追加したメソッドに何かあれば対応しますので教えてください。1週間後くらいに本チケットはcloseしようかと思います。