docs(spec/package):about model of sutera package using yaml #67
Conversation
…o docs/Why-sutera-need-to-maintain-idempotence
change title Co-authored-by: AsPulse / あすぱる <[email protected]>
…o docs/Why-sutera-need-to-maintain-idempotence
…o docs/Why-sutera-need-to-maintain-idempotence
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
textlint
package/About_model_of_sutera_package_using_yaml.md|39 col 42| 漢字が7つ以上連続しています: 次元直行座標系 (ja-technical-writing/max-kanji-continuous-len)
package/About_model_of_sutera_package_using_yaml.md|39 col 53| 箇条書き: "である"調 と "ですます"調 が混在
=> "である"調 の文体に、次の "ですます"調 の箇所があります: "ます。"
Total:
である : 0
ですます: 17
(ja-technical-writing/no-mix-dearu-desumasu)
package/About_model_of_sutera_package_using_yaml.md|39 col 55| Should remove period mark("。") at end of list item. (period-in-list-item)
package/About_model_of_sutera_package_using_yaml.md|40 col 34| 箇条書き: "である"調 と "ですます"調 が混在
=> "である"調 の文体に、次の "ですます"調 の箇所があります: "です。"
Total:
である : 0
ですます: 17
(ja-technical-writing/no-mix-dearu-desumasu)
package/About_model_of_sutera_package_using_yaml.md|40 col 81| 箇条書き: "である"調 と "ですます"調 が混在
=> "である"調 の文体に、次の "ですます"調 の箇所があります: "ます"
Total:
である : 0
ですます: 17
(ja-technical-writing/no-mix-dearu-desumasu)
package/About_model_of_sutera_package_using_yaml.md|86 col 1| Line 86 sentence length(107) exceeds the maximum sentence length of 100.
Over 7 characters. (ja-technical-writing/sentence-length)
package/About_model_of_sutera_package_using_yaml.md|87 col 76| 文末が"。"で終わっていません。 (ja-technical-writing/ja-no-mixed-period)
|
@AsPulse せかんどれびゅーたのんます！おねがい！なんでもするかも！ |
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
textlint
🚫 [textlint] <eslint.rules.ja-technical-writing/sentence-length> reported by reviewdog 🐶
Line 71 sentence length(107) exceeds the maximum sentence length of 100.
Over 7 characters. (ja-technical-writing/sentence-length)
🚫 [textlint] <eslint.rules.ja-technical-writing/ja-no-mixed-period> reported by reviewdog 🐶
文末が"。"で終わっていません。 (ja-technical-writing/ja-no-mixed-period)
|
textlintくんうるさすぎるので一旦これで黙らせてもいいかも <!-- textlint-disable -->
ここに偽陽性が出る文章
<!-- textlint-enable --> |
|
@AsPulse れびゅーおねがいします！落ち着いたときで大丈夫です！ |
There was a problem hiding this comment.
とりあえずPRのタイトルをConventional COmmitに沿った形式にしてください！
あとこれ、prh案件が多いね……
基本的に文章中に登場する「仕様として正式な文字列を表す」部分は、backquoteでかこってください。 (正式な文字列であることを明示する目的や、翻訳の際に誤って訳されるのを防ぐ目的などがあります。)
たとえば
- 設定しない場合は空配列
[]を設定してください。 (29行目) - 球の半径
rを設定してください。 (39行目)
また、命名規則はsnake_caseでお願いします。
体裁のレビューの他に中身のレビューもしないといけないので、一旦中身のレビューはできていないのですが送っちゃいますね！
| #### cupsule | ||
| カプセル方のコライダーです。球の半径rと高さhを指定してください |
There was a problem hiding this comment.
| #### cupsule | |
| カプセル方のコライダーです。球の半径rと高さhを指定してください | |
| #### capsule | |
| カプセル形のコライダーです。球の半径rと高さhを指定してください |
| [model.yaml](./model.yaml)に本項目で説明したワールドに設置する3Dモデルに関するyamlファイルの例が記載されています。 | ||
|
|
||
| ## 参考文献,脚注 | ||
| ^[1~] YAML (「YAML Ain't Markup Language」の再帰的頭字語) は、人間に優しく、日常の一般的なタスクで最新のプログラミング言語とうまく連携するように設計されたデータシリアル化言語です。^[2] |
There was a problem hiding this comment.
🚫 [textlint] <eslint.rules.ja-technical-writing/sentence-length> reported by reviewdog 🐶
Line 71 sentence length(107) exceeds the maximum sentence length of 100.
Over 7 characters. (ja-technical-writing/sentence-length)
|
|
||
| ## 参考文献,脚注 | ||
| ^[1~] YAML (「YAML Ain't Markup Language」の再帰的頭字語) は、人間に優しく、日常の一般的なタスクで最新のプログラミング言語とうまく連携するように設計されたデータシリアル化言語です。^[2] | ||
| ^[2~] yaml公式サイトspecification v1.2.2 https://yaml.org/spec/1.2.2/ 閲覧2024/7/23 |
There was a problem hiding this comment.
🚫 [textlint] <eslint.rules.ja-technical-writing/ja-no-mixed-period> reported by reviewdog 🐶
文末が"。"で終わっていません。 (ja-technical-writing/ja-no-mixed-period)
slotsu0809
changed the title
slotsu0809
changed the title
| z: 1 | ||
| ``` | ||
| #### `sphere` | ||
| 球形のコライダーです。球の半径`r`を指定してください |
There was a problem hiding this comment.
| 球形のコライダーです。球の半径`r`を指定してください | |
| 球形のコライダーです。球の半径`r`を指定してください。 |
| ``` | ||
|
|
||
| #### `cupsule` | ||
| カプセル方のコライダーです。球の半径`r`と高さ`h`を指定してください |
There was a problem hiding this comment.
| カプセル方のコライダーです。球の半径`r`と高さ`h`を指定してください | |
| カプセル方のコライダーです。球の半径`r`と高さ`h`を指定してください。 |
close #37