google / google/eDistantObject

Detail is slightly confusing

オープン
#239 コメント 0 件 リアクション 1 件 担当者 0 名 GitHub で見る
主要言語
Objective-C
スター
176
フォーク
36
PR マージ指標
30日以内にマージされた PR はありません

説明

Hi,

Here is a few feedback on https://github.com/google/eDistantObject/blob/master/docs/detail.md
I'm trying to understand it, and thought maybe you'd want some feedback.
I must note I'm new to Objective-C/iOS development, trying to learn (which is why I read the doc)

In the image, what is "v@:"?

Why is the disjunction "value type/reference type" done first in the section "Boxing and Unboxing parameters" and then in "Value Type (pass by value) and Reference Type (pass by reference)". If there is a difference, I don't get it.

In "Boxing and Unboxing Parameters" you state it's a good idea to create a service so that the client can listen to request by the host. Would you mind adding a link to show how to do that? Because this seems absent from the examples of [setup](https://github.com/google/eDistantObject/blob/master/docs/setup.md) or [readme](https://github.com/google/eDistantObject/blob/master/README.md)

> Only a reference to NSObject * is supported and only seen as an out parameter

I find this sentence quite confusing. Where it is supported? I assume you mean that some other things are forbidden. What is forbidden and where? I believe being explicit would help.

> For example, this type can also be seen as a pointer to a c-array of NSObject * and if one is used to iterate over it, it will crash.

What does "one" refere too? And what is "it" (well, I assume that "it" and "one" refers to the same thing)

> and in order to let EDO know it is a value type and passed by value, override -(BOOL)edo_isEDOValueType to returns YES.

I was confused. Because the sentence begin with "all objects". I assume the end of this sentence refers to a single object. In this case, I guess that it would help to rewrite it as:

> in order to let EDO knows that an object `o` must behave as value type and hence be passed by value, you should override its method `-(BOOL)edo_isEDOValueType` to return `YES`.

However, I'm far from sure this is what you meant, so any clarification would help, especially if actually I misunderstood

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

docs/setup.md および README.md と併せて docs/detail.md を読み、"v@:"、boxing と unboxing、NSObject ポインター、EDO 値型に関する記述に重点を置いてください。用語と重複した説明を明確にし、適切な例が存在する場合は、要求されたサービスリスニングの例へのリンクを追加してください。新しく参加する人がサポートされているケースを理解し、セットアップのガイダンスに従えるようになれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
ios, objective-c
領域
documentation
issue の種類
ドキュメント
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。