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.

Sign up for GitHub

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

Add eb90-rs link to docs #255

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add eb90-rs link to docs #255

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/component_driver/communication_with_components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ https://github.com/arkedge/c2a-core/blob/45d78a05c339c285b5aa0c2fcbf57c1b105137e
UART などで接続されたコンポーネント間の通信といった，軽微な通信ノイズの誤り検出のみ必要な場合に用いる．
ネットワーク層として EB90 Packet や Common Packet などが標準的に使用される．

- Rust 実装: [eb90-rs](https://github.com/arkedge/eb90-rs)

Comment on lines +71 to +72
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

下の 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)

でよいかと．

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

下のは一切実装ではなくパケット構造が書いてあるコメント見せてるだけでしょ．で，その詳細な説明が「各フィールドの説明」にあるんだから，その直前に無いと絶対おかしい．なんならこのコメント自体そのセクションの最初でいいまである．

Copy link
Member

@meltingrabbit meltingrabbit Dec 25, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

パケット構造が書いてあるコメント見せてるだけでしょ．で，その詳細な説明が「各フィールドの説明」にある

そう．そういう意味だと，実装へのリンクは最後（つまり「各フィールドの説明」よりも後）のほうが良さそうな気がしませんか？

あと， ul がぽつんと唐突に出てくるのも文章として違和感があるので

#### 各フィールドの説明
~~~ 説明 ~~~

の後ろに

#### 実装
-  Rust 実装: [eb90-rs](https://github.com/arkedge/eb90-rs)
- C 実装: c へのリンク

とするのが全体的にバランスいいと思いました．

まず，全体的な説明があり → 構造の例示と各フィールドの説明 → そして具体の実装，という文章構造

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

実装の解説ではなく，実装がどこにあるか，というだけの情報は概要寄りの話だと思いますよ．ul が唐突にあるのはヘン，は分かるけど．

https://github.com/arkedge/c2a-core/blob/45d78a05c339c285b5aa0c2fcbf57c1b105137e9/Drivers/Protocol/eb90_frame_for_driver_super.h#L1-L33

#### 各フィールドの説明
Expand Down
Loading