Add eb90-rs link to docs #255
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sksat
added
documentation
Comment on lines
+71
to
+72
| - Rust 実装: [eb90-rs](https://github.com/arkedge/eb90-rs) | ||
|
|
There was a problem hiding this comment.
下の C の実装より下でかつ， ul いらない気がします．
つまり
https://github.com/arkedge/c2a-core/blob/45d78a05c339c285b5aa0c2fcbf57c1b105137e9/Drivers/Protocol/eb90_frame_for_driver_super.h#L1-L33
Rust 実装: [eb90-rs](https://github.com/arkedge/eb90-rs)
でよいかと．
There was a problem hiding this comment.
下のは一切実装ではなくパケット構造が書いてあるコメント見せてるだけでしょ．で，その詳細な説明が「各フィールドの説明」にあるんだから，その直前に無いと絶対おかしい．なんならこのコメント自体そのセクションの最初でいいまである．
There was a problem hiding this comment.
パケット構造が書いてあるコメント見せてるだけでしょ．で，その詳細な説明が「各フィールドの説明」にある
そう．そういう意味だと，実装へのリンクは最後（つまり「各フィールドの説明」よりも後）のほうが良さそうな気がしませんか？
あと， ul がぽつんと唐突に出てくるのも文章として違和感があるので
#### 各フィールドの説明
~~~ 説明 ~~~
の後ろに
#### 実装
- Rust 実装: [eb90-rs](https://github.com/arkedge/eb90-rs)
- C 実装: c へのリンク
とするのが全体的にバランスいいと思いました．
まず，全体的な説明があり → 構造の例示と各フィールドの説明 → そして具体の実装，という文章構造
There was a problem hiding this comment.
実装の解説ではなく，実装がどこにあるか，というだけの情報は概要寄りの話だと思いますよ．ul が唐突にあるのはヘン，は分かるけど．
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
概要
eb90-rs のリンクをドキュメントに追加する