Fix URI, Request target terminology.
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 28/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- rust
調査の方向性
まず crate の現在の Uri 構造体と request-target の処理に関するドキュメントを確認し、次にレポートに記載されている関連 issue を確認します。request-target の形式を用語が一貫して説明し、公開名の変更について実装前に互換性に関する明示的な判断がなされていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
As this crate stands for correctness, it is imperative to fix misleading terminology that is used through out the request-target handling documentation.
- Use
HttpRequestTargetinstead ofUri, as it really handles only request target forms, not identity scheme in any way. This may be difficult, noting it is a breaking change. Can alias and deprecate though. - In documentation of current
Uristruct, There is extensive use ofabsolute-uri/relative-uridichotomy to show that, forabsolute-uriit hasport,scheme, etc, and forrelative-uriit won't. This is grossly misleading. As this crate is not handling identifiers in the first place, there is no such thing asabsolute-uri/relative-uridichotomy. It is instead dichotomy ofabsolute-form/origin-formof request target. i.e, request-target inabsolute-formencodes port, scheme etc, and that inorigin-formdoesn't, as they have to be runtime-resolved. That's also the reason the mis-termedrelative-uris starts with a/, as they are not really identifiers, relative/absolute, butorigin-formresource targets.
The second point of fixing documentation may not be breaking change, and possible i hope.
We can see many misunderstandings due to this misleading. for example
- #127, As These are not identifiers, but representation of request-target values, there is no uri, and thus no fragments in first place.
- #465 Same mis-issue of using request-target representation to represent identifiers
- #469 They even mention other uri-schemes in issue discription, and also quotes uri-standard. Same mis-issue.
- #396 ,
urlcrate is for identifiers, where as this one only deals with request-targets. - #379 same issue. This crate doesn't handles uris in first place. only request targets.
- #342
- #311
- #323
- #421
- #306
- #176
- #110
so on, so forth.
For amount of confusion, ad misleading it creates, It may be helpful to fix at least terminology in docs, and fix Uri name for struct before 1.0
- 主要言語
- Rust
- スター
- 1.4k
- フォーク
- 378
- 平均マージ
- 1日 21時間
- マージ済み PR(30日)
- 5
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
hyperium/http のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 62/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 58/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 62/100
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
BurntSushi/jiff#653 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
ZcashFoundation/zeeder#106 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
oxidize-rb/rb-sys#807 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
-
todo:ticket
難易度 2/5 1〜2日 初心者へのやさしさ 74/100