Skip to content

Commit 78c4442

Browse files
authored
Merge pull request #7314 from danicruz0415/main
Fixes language reference and Markdown syntax
2 parents c377b53 + 54f5322 commit 78c4442

6 files changed

+100
-100
lines changed

contributor_docs/friendly_error_system.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ i18next supports interpolation, which allows us to pass a variable to generate a
8585
Here, the key is `greeting`, and the variable name is `who`.
8686

8787
To dynamically generate this message, we will need to pass a value:
88-
```JavaScript
88+
```javascript
8989
translator('greeting', { who: 'everyone' } );
9090
```
9191
The result generated by `translator` will look like this:
@@ -98,7 +98,7 @@ Here is an item from `fes`'s `fileLoadError` that demonstrates interpolation:
9898
"image": "It looks like there was a problem loading your image. {{suggestion}}"
9999
```
100100
To dynamically generate the final message, the FES will call `translator()` with the key and a pre-generated `suggestion` value.
101-
```JavaScript
101+
```javascript
102102
translator('fes.fileLoadError.image', { suggestion });
103103
```
104104

@@ -144,7 +144,7 @@ For full reference, please see our [Dev Notes].
144144
#### FES Message Displayer
145145
`fes_core.js/_friendlyError()` prints generated friendly error messages in the console. For example:
146146

147-
```JavaScript
147+
```javascript
148148
p5._friendlyError(
149149
translator('fes.globalErrors.type.notfunc', translationObj)
150150
);
@@ -157,7 +157,7 @@ There may be cases where you want to [disable the FES for performance].
157157
`p5.disableFriendlyErrors` allows you to turn off the FES when set to `true`.
158158

159159
Example:
160-
```JavaScript
160+
```javascript
161161
p5.disableFriendlyErrors = true;
162162

163163
function setup() {

contributor_docs/ja/fes_reference_dev_notes.md

+40-40
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@
2323
`_report()` は、エラーヘルパーメッセージの出力をコンソールに直接印刷する主要な関数です。
2424
`_fesLogger` が設定されている場合(つまり、テストを実行している場合)、`_report` は console.log の代わりに `_fesLogger` を呼び出します。
2525
##### 语法
26-
````JavaScript
26+
```javascript
2727
_report(message)
28-
````
29-
````JavaScript
28+
```
29+
```javascript
3030
_report(message, func)
31-
````
32-
````JavaScript
31+
```
32+
```javascript
3333
_report(message, func, color)
34-
````
34+
```
3535
##### 引数
3636
```
3737
@param {String} message 出力するメッセージ
@@ -70,15 +70,15 @@ _friendlyError
7070

7171

7272
##### 構文
73-
````JavaScript
73+
```javascript
7474
_friendlyError(message)
75-
````
76-
````JavaScript
75+
```
76+
```javascript
7777
_friendlyError(message, func)
78-
````
79-
````JavaScript
78+
```
79+
```javascript
8080
_friendlyError(message, func, color)
81-
````
81+
```
8282
##### 引数
8383
```
8484
@param {String} message 出力するメッセージ
@@ -113,17 +113,17 @@ _friendlyFileLoadError
113113
_report
114114
```
115115
##### 構文
116-
````JavaScript
116+
```javascript
117117
_friendlyFileLoadError(errorType, filePath)
118-
````
118+
```
119119
##### 引数
120120
```
121121
@param {Number} errorType ファイル読み込みエラータイプの数値
122122
@param {String} filePath エラーの原因となったファイルパス
123123
```
124124
#####
125125
<ins>ファイル読み込みエラーの例</ins>
126-
````JavaScript
126+
```javascript
127127
/// missing font file
128128
let myFont;
129129
function preload() {
@@ -136,7 +136,7 @@ function setup() {
136136
text('p5*js', 10, 50);
137137
};
138138
function draw() {};
139-
````
139+
```
140140
FESはコンソールに次のメッセージを生成します:
141141
> 🌸 p5.jsが言っています: フォントファイルの読み込み中に問題が発生したようです。ファイルパス [assets/OpenSans-Regular.ttf] が正しいか確認し、フォントファイルをオンラインサーバーにホストするか、またはローカルサーバーを実行してみてください。[https://github.com/processing/p5.js/wiki/Local-server]
142142
@@ -199,28 +199,28 @@ validateParameters
199199
friendlyWelcome
200200
```
201201
##### 文法
202-
````JavaScript
202+
```javascript
203203
_validateParameters(func, args)
204-
````
204+
```
205205
##### 引数
206206
```
207207
@param {String} func 関数名
208208
@param {Array} args ユーザー入力パラメータ
209209
```
210210
#####
211211
<ins>欠落パラメータの例</ins>
212-
````JavaScript
212+
```javascript
213213
arc(1, 1, 10.5, 10);
214-
````
214+
```
215215
FESはコンソールに以下のメッセージを生成します:
216216
> 🌸 p5.jsが言うには、arc()は位置#4(ゼロベースのインデックス)で空の変数を受け取ったようです。これが意図的でない場合、通常はスコープの問題です:[https://p5js.org/examples/data-variable-scope.html][http://p5js.org/reference/#p5/arc]
217217
218218
> 🌸 p5.jsが言うには、arc()は位置#5(ゼロベースのインデックス)で空の変数を受け取ったようです。これが意図的でない場合、通常はスコープの問題です:[https://p5js.org/examples/data-variable-scope.html][http://p5js.org/reference/#p5/arc]
219219
220220
<ins>型の不一致の例</ins>
221-
````JavaScript
221+
```javascript
222222
arc('1', 1, 10.5, 10, 0, Math.PI, 'pie');
223-
````
223+
```
224224
FESはコンソールに以下のメッセージを生成します:
225225
> 🌸 p5.jsが言うには、arc()はパラメータ#0(ゼロベースのインデックス)でNumberを期待していましたが、文字列を受け取りました。[http://p5js.org/reference/#/p5/arc]
226226
##### 位置
@@ -259,16 +259,16 @@ try { someCode(); } catch(err) { p5._fesErrorMonitor(err); }
259259
printFriendlyStack
260260
```
261261
##### 文法
262-
````JavaScript
262+
```javascript
263263
fesErrorMonitor(event)
264-
````
264+
```
265265
##### パラメータ
266266
```
267267
@param {*} e エラーイベント
268268
```
269269
###
270270
<ins>内部エラーの例 1</ins>
271-
```JavaScript
271+
```javascript
272272
function preload() {
273273
// プリロードでのbackground()の呼び出しにより発生します。
274274
// 間違い
@@ -279,7 +279,7 @@ FES将在控制台中生成以下消息:
279279
> 🌸 p5.jsが言うには、backgroundを呼び出したとき(sketch.jsの4行目[http://localhost:8000/lib/empty-example/sketch.js:4:3])、p5jsライブラリ内部でエラーが発生しました。エラーメッセージは「未定義のプロパティ'background'を読み取れません」です。(特に説明がない限り、これはpreloadからbackgroundが呼び出されたためかもしれません。preload関数内にはload関数(loadImage、loadJSON、loadFont、loadStringsなど)以外は含まれていないべきです。)(http://p5js.org/reference/#/p5/preload)
280280
281281
<ins>内部エラーの例 2</ins>
282-
```JavaScript
282+
```javascript
283283
function setup() {
284284
cnv = createCanvas(200, 200);
285285
cnv.mouseClicked();
@@ -289,7 +289,7 @@ FES将在控制台中生成以下消息:
289289
> 🌸 p5.jsが言うには、mouseClickedを呼び出したとき(sketch.jsの3行目[http://localhost:8000/lib/empty-example/sketch.js:3:7])、p5jsライブラリ内部でエラーが発生しました。エラーメッセージは「未定義のプロパティ'bind'を読み取れません」です。(特に説明がない限り、これはmouseClickedへの引数に問題がある可能性があります。)(http://p5js.org/reference/#/p5/mouseClicked)
290290
291291
<ins>ユーザー例のスコープエラーの例</ins>
292-
```JavaScript
292+
```javascript
293293
function setup() {
294294
let b = 1;
295295
}
@@ -300,7 +300,7 @@ function draw() {
300300
> 🌸 p5.jsが言うには、「b」が現在のスコープ内で定義されていないため、エラーが発生しました(sketch.jsの5行目[http://localhost:8000/lib/empty-example/sketch.js:5:3])。コード内で定義している場合は、そのスコープ、綴り、大文字と小文字を確認してください(JavaScriptは大文字と小文字を区別します)。さらに情報:https://p5js.org/examples/data-variable-scope.html https://developer.mozilla.org/docs/Web/JavaScript/Reference/Errors/Not_Defined#What_went_wrong
301301
302302
<ins>ユーザー例のタイプミスの例</ins>
303-
```JavaScript
303+
```javascript
304304
function setup() {
305305
colour(1, 2, 3);
306306
}
@@ -327,22 +327,22 @@ core/friendly_errors/fes_core.js
327327

328328
#####
329329
<ins>p5.j​​sの保持定数を再定義する例</ins>
330-
````JavaScript
330+
```javascript
331331
function setup() {
332332
// PI は p5.js の予約定数です
333333
let PI = 100;
334334
}
335-
````
335+
```
336336
FESはコンソールに以下のメッセージを生成します:
337337
> 🌸 p5.jsのヒント:p5.jsの予約された変数「PI」を使用しています。変数名を他の名前に変更してください。(https://p5js.org/reference/#/p5/PI)
338338
339339
<ins>p5.j​​sの予約関数の再定義例</ins>
340-
````JavaScript
340+
```javascript
341341
function setup() {
342342
// text は p5.js の予約関数です
343343
let text = 100;
344344
}
345-
````
345+
```
346346
FESはコンソールに以下のメッセージを生成します:
347347
> 🌸 p5.jsのヒント:p5.jsの予約された関数「text」を使用しています。関数名を他の名前に変更してください。
348348
@@ -357,20 +357,20 @@ core/friendly_errors/sketch_reader.js
357357
`fes.checkUserDefinedFns` タイプのわかりやすいエラー メッセージを生成して出力します。
358358

359359
##### 文法
360-
````JavaScript
360+
```javascript
361361
checkForUserDefinedFunctions(context)
362-
````
362+
```
363363
##### 引数
364364
```
365365
@param {*} context 現在のデフォルトのコンテキスト。
366366
「グローバル モード」ではウィンドウに設定し、「インスタンス モード」では p5 インスタンスに設定します。
367367
```
368368
#####
369-
````JavaScript
369+
```javascript
370370
function preLoad() {
371371
loadImage('myimage.png');
372372
}
373-
````
373+
```
374374
FESはコンソールに以下のメッセージを生成します:
375375
> 🌸 p5.jsのヒント:preLoadと書くべきところをpreloadと誤って書いているようです。これが意図していない場合は、訂正してください。(http://p5js.org/reference/#/p5/preload)
376376
@@ -413,7 +413,7 @@ p5.newObject = function(parameter) {
413413
this.parameter = 'some parameter';
414414
this.name = 'p5.newObject';
415415
};
416-
````
416+
```
417417
* インラインドキュメント:許可されるパラメータタイプには`Boolean``Number``String`、およびオブジェクトの名前が含まれます(上記の箇条書きを参照)。任意の配列パラメータには`Array`を使用してください。必要に応じて、説明部分で許可される特定のタイプの配列パラメータ(例:`Number[]``String[]`)を解説できます。
418418
* 現在サポートされているクラスタイプ(それぞれの`name`パラメータを持つ):`p5.Color``p5.Element``p5.Graphics``p5.Renderer``p5.Renderer2D``p5.Image``p5.Table``p5.TableRow``p5.XML``p5.Vector``p5.Font``p5.Geometry``p5.Matrix``p5.RendererGL`
419419

@@ -424,7 +424,7 @@ p5.newObject = function(parameter) {
424424
この機能を無効にするには、コードの先頭に次の行を追加します:
425425

426426

427-
```JavaScript
427+
```javascript
428428
p5.disableFriendlyErrors = true; // FESを無効にする
429429

430430
function setup() {
@@ -441,7 +441,7 @@ function draw() {
441441
## 既知の制限
442442

443443
* FESはまだ偽陰性の状況を引き起こす可能性があります。これは通常、設計と実際の使用状況の間の不一致によって引き起こされます(例えば、描画関数は2Dおよび3D設定で交換可能に使用できるように最初に設計されましたが)、例えば:
444-
```JavaScript
444+
```javascript
445445

446446
const x3; // 未定義
447447
line(0, 0, 100, 100, x3, Math.PI);
@@ -470,7 +470,7 @@ line(0, 0, 100, 100, x3, Math.PI);
470470
* `sketch_reader.js`のコードの読み取りと変数/関数名の抽出機能を改善する(コード内で宣言された関数と変数名を抽出する)。例えば、すべてのコードが一行に書かれている場合、`sketch_reader.js`は正しく変数/関数名を抽出できません。これらの"逃げ"ケースをすべて識別し、それらをキャッチするための単体テストを追加するための将来の提案を歓迎します。
471471

472472
* `sketch_reader.js`は拡張可能で、新しい機能を追加することができます(例:ユーザーが`draw()`関数内で変数を宣言したときに警告を発する)。ユーザーをよりよく支援するためです。
473-
```JavaScript
473+
```javascript
474474
// 这段代码片段使用新函数包装了 window.console 方法,以修改其功能
475475
// 目前尚未实现,但可以使用它来提供更好格式的错误消息
476476
const original = window.console;

contributor_docs/ja/friendly_error_system.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ i18next は補間をサポートしているため、変数を渡してメッセ
8282
ここで、キーは「greeting」、変数名は「who」です。
8383

8484
このメッセージを動的に生成するには、値を渡す必要があります。
85-
```JavaScript
85+
```javascript
8686
translator('greeting', { who: 'everyone' } );
8787
```
8888
「translator」によって生成された結果は次のようになります。
@@ -95,7 +95,7 @@ translator('greeting', { who: 'everyone' } );
9595
"image": "看起来加载图像时出现问题。{{suggestion}}"
9696
```
9797
最終メッセージを動的に生成するために、FES はこのキーと事前に生成された `suggestion` 値を使用して `translator()` を呼び出します。
98-
```JavaScript
98+
```javascript
9999
translator('fes.fileLoadError.image', { suggestion });
100100
```
101101

@@ -137,7 +137,7 @@ FESのコアコンポーネントは以下の場所で見つけることがで
137137
#### FESメッセージ表示
138138
`fes_core.js/_friendlyError()` 生成されたわかりやすいエラー メッセージをコンソールに出力します。 例えば:
139139

140-
```JavaScript
140+
```javascript
141141
p5._friendlyError(
142142
translator('fes.globalErrors.type.notfunc', translationObj)
143143
);
@@ -150,7 +150,7 @@ p5._friendlyError(
150150
`p5.disableFriendlyErrors``true` に設定されている場合、FES をオフにすることができます。
151151

152152
例:
153-
```JavaScript
153+
```javascript
154154
p5.disableFriendlyErrors = true;
155155

156156
function setup() {

contributor_docs/ko/friendly_error_system.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ FES는 네 종류의 오류를 감지하고 메시지를 출력할 수 있습니
2626
* 이 함수는 파일이 올바로 로드되지 않으면 친절한 오류 메시지를 생성하고, 표시합니다. 그리고 로드하기에는 파일이 너무 큰지 확인해서 경고를 생성하기도 합니다.
2727
* 이것은 다음과 같이 호출할 수 있습니다.: `p5._friendlyFileLoadError(ERROR_TYPE, FILE_PATH)`.
2828
* 파일 로딩 오류 예시:
29-
````javascript
29+
```javascript
3030
/// 폰트 파일 누락
3131
let myFont;
3232
function preload() {
@@ -42,7 +42,7 @@ function draw() {};
4242
/// 콘솔에 다음의 메시지가 생성됩니다.:
4343
/// > p5.js: 폰트를 로드하는 데 문제가 있는 것 같습니다. 파일 경로 [assets / OpenSans-Regular.ttf]가 올바른지, 폰트를 온라인 호스팅하는지, 또는 로컬 서버가 실행 중인지 확인하십시오.
4444

45-
````
45+
```
4646
* 현재 버전에는 `image`, `XML`, `table`, `text`, `json`, `font`에 대한 오류 메시지를 생성하는 템플릿이 포함되어 있습니다.
4747
* `image/loading_displaying/loadImage()`, `io/files/loadFont()`, `io/files/loadTable()`, `io/files/loadJSON()`, `io/files/loadStrings()`, `io/files/loadXML()`, `io/files/loadBytes()`에 구현되었습니다.
4848
* 파일 크기가 커서 로드하는 중 생기는 오류는 모두 loadX 메소드에 구현되었습니다.
@@ -51,19 +51,19 @@ function draw() {};
5151
* 이 함수는 `docs/reference/data.json`에 있는 입력 파라미터 정보와 일치하는지 파라미터 검증을 실행합니다. 이것은 함수 호출이 올바른 개수와 파라미터형을 가지고 있는지 확인합니다.
5252

5353
* 파라미터 누락 예시:
54-
````javascript
54+
```javascript
5555
arc(1, 1, 10.5, 10);
5656
/// 콘솔에 다음의 메시지가 생성됩니다.:
5757
/// > pt.js: arc() 함수의 입력 파라미터 중 4번째 자리(인덱스는 0부터 시작)에 빈 값이 들어온 것 같습니다. 의도한 것이 아니라면, 이것은 종종 범위의 문제입니다.: [https://p5js.org/examples/data-variable-scope.html]. [http://p5js.org/reference/#p5/arc]
5858
/// > pt.js: arc() 함수의 입력 파라미터 중 5번째 자리(인덱스는 0부터 시작)에 빈 값이 들어온 것 같습니다. 의도한 것이 아니라면, 이것은 종종 범위의 문제입니다.: [https://p5js.org/examples/data-variable-scope.html]. [http://p5js.org/reference/#p5/arc]
5959

60-
````
60+
```
6161
* 자료형 오류 예시:
62-
````javascript
62+
```javascript
6363
arc('1', 1, 10.5, 10, 0, Math.PI, 'pie');
6464
/// 콘솔에 다음의 메시지가 생성됩니다.:
6565
/// > p5.js:arc() 함수의 입력 파라미터 중 0번째 자리에는(인덱스는 0부터 시작)에는 숫자가 들어와야 하는데 문자열이 들어왔습니다. [http://p5js.org/reference/#p5/arc]
66-
````
66+
```
6767
* 이것은 다음과 같이 호출할 수 있습니다.: `p5._validateParameters(FUNCT_NAME, ARGUMENTS)` 또는 `p5.prototype._validateParameters(FUNCT_NAME, ARGUMENTS)` 는 파라미터 검증이 필요한 함수 내부에서 씁니다. 일반적인 목적으로는 `p5._validateParameters` 를 사용하는 것이 좋습니다. `p5.prototype._validateParameters(FUNCT_NAME, ARGUMENTS)` 은 주로 디버깅이나 단위 테스트 목적으로 사용합니다.
6868
* `color/creating_reading`, `core/2d_primitives`, `core/curves`, 그리고 `utilities/string_functions` 의 함수로 구현되어 있습니다.
6969

@@ -74,12 +74,12 @@ arc('1', 1, 10.5, 10, 0, Math.PI, 'pie');
7474
## 개발자 유의사항
7575
* p5.js 객체를 생성할 때: 파라미터로 사용될 모든 p5.js 객체는 클래스 선언부에서 `name` 파라미터(오브젝트의 이름) 값을 지정해야 합니다. 예를 들면 다음과 같습니다.:
7676

77-
````javascript
77+
```javascript
7878
p5.newObject = function(parameter) {
7979
this.parameter = '파라미터';
8080
this.name = 'p5.newObject';
8181
};
82-
````
82+
```
8383
* 인라인 문서: 허용되는 파라미터 타입은 `Boolean`, `Number`, `String`, 그리고 객체의 이름(위의 주요 항목 참고)입니다. 유형에 관계없이 배열 파라미터에는 `Array` 를 쓰세요. 필요한 경우, 어떤 특정 타입의 배열 파라미터가 허용되는지(예시 `Number[]`, `String[]`) 설명 섹션에 적습니다.
8484
* 현재 지원되는 클래스 타입은 이렇습니다( `name` 파라미터를 가집니다): `p5.Color`, `p5.Element`, `p5.Graphics`, `p5.Renderer`, `p5.Renderer2D`, `p5.Image`, `p5.Table`, `p5.TableRow`, `p5.XML`, `p5.Vector`, `p5.Font`, `p5.Geometry`, `p5.Matrix`, `p5.RendererGL`.
8585

0 commit comments

Comments
 (0)