Skip to content

返値が配列である場合の表記法 #6

Open
@ykominami

Description

@ykominami

balancer.rstのBalancer.controlメソッドの返値が配列である。

https://github.com/TECS-WG/tecs-docs/blob/master/docs/mruby-on-ev3rt%2Btecs/balancer.rst

他のメソッドの説明ではなかったので、どうするのがよいか。
現在は、以下の通りにした。

  • 返値の型:[Int] Rubyの公式のリファレンスマニュアルの表記に倣った
  • 返値の説明 0番目要素、1番目の要素の説明を0から始まる番号付きリスト(列挙リスト)で表記。Rubyの公式リファレンスでは特定の表記はない(返値については、型以外は、具体例を示ている)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions