Skip to content

Commit

Permalink
Merge branch 'processing:main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
Dhanush111 authored Oct 15, 2024
2 parents 0373e4f + 78c4442 commit d539cf3
Show file tree
Hide file tree
Showing 6 changed files with 100 additions and 100 deletions.
8 changes: 4 additions & 4 deletions contributor_docs/friendly_error_system.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ i18next supports interpolation, which allows us to pass a variable to generate a
Here, the key is `greeting`, and the variable name is `who`.

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

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

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

Example:
```JavaScript
```javascript
p5.disableFriendlyErrors = true;

function setup() {
Expand Down
80 changes: 40 additions & 40 deletions contributor_docs/ja/fes_reference_dev_notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@
`_report()` は、エラーヘルパーメッセージの出力をコンソールに直接印刷する主要な関数です。
`_fesLogger` が設定されている場合(つまり、テストを実行している場合)、`_report` は console.log の代わりに `_fesLogger` を呼び出します。
##### 语法
````JavaScript
```javascript
_report(message)
````
````JavaScript
```
```javascript
_report(message, func)
````
````JavaScript
```
```javascript
_report(message, func, color)
````
```
##### 引数
```
@param {String} message 出力するメッセージ
Expand Down Expand Up @@ -70,15 +70,15 @@ _friendlyError


##### 構文
````JavaScript
```javascript
_friendlyError(message)
````
````JavaScript
```
```javascript
_friendlyError(message, func)
````
````JavaScript
```
```javascript
_friendlyError(message, func, color)
````
```
##### 引数
```
@param {String} message 出力するメッセージ
Expand Down Expand Up @@ -113,17 +113,17 @@ _friendlyFileLoadError
_report
```
##### 構文
````JavaScript
```javascript
_friendlyFileLoadError(errorType, filePath)
````
```
##### 引数
```
@param {Number} errorType ファイル読み込みエラータイプの数値
@param {String} filePath エラーの原因となったファイルパス
```
#####
<ins>ファイル読み込みエラーの例</ins>
````JavaScript
```javascript
/// missing font file
let myFont;
function preload() {
Expand All @@ -136,7 +136,7 @@ function setup() {
text('p5*js', 10, 50);
};
function draw() {};
````
```
FESはコンソールに次のメッセージを生成します:
> 🌸 p5.jsが言っています: フォントファイルの読み込み中に問題が発生したようです。ファイルパス [assets/OpenSans-Regular.ttf] が正しいか確認し、フォントファイルをオンラインサーバーにホストするか、またはローカルサーバーを実行してみてください。[https://github.com/processing/p5.js/wiki/Local-server]
Expand Down Expand Up @@ -199,28 +199,28 @@ validateParameters
friendlyWelcome
```
##### 文法
````JavaScript
```javascript
_validateParameters(func, args)
````
```
##### 引数
```
@param {String} func 関数名
@param {Array} args ユーザー入力パラメータ
```
#####
<ins>欠落パラメータの例</ins>
````JavaScript
```javascript
arc(1, 1, 10.5, 10);
````
```
FESはコンソールに以下のメッセージを生成します:
> 🌸 p5.jsが言うには、arc()は位置#4(ゼロベースのインデックス)で空の変数を受け取ったようです。これが意図的でない場合、通常はスコープの問題です:[https://p5js.org/examples/data-variable-scope.html][http://p5js.org/reference/#p5/arc]
> 🌸 p5.jsが言うには、arc()は位置#5(ゼロベースのインデックス)で空の変数を受け取ったようです。これが意図的でない場合、通常はスコープの問題です:[https://p5js.org/examples/data-variable-scope.html][http://p5js.org/reference/#p5/arc]
<ins>型の不一致の例</ins>
````JavaScript
```javascript
arc('1', 1, 10.5, 10, 0, Math.PI, 'pie');
````
```
FESはコンソールに以下のメッセージを生成します:
> 🌸 p5.jsが言うには、arc()はパラメータ#0(ゼロベースのインデックス)でNumberを期待していましたが、文字列を受け取りました。[http://p5js.org/reference/#/p5/arc]
##### 位置
Expand Down Expand Up @@ -259,16 +259,16 @@ try { someCode(); } catch(err) { p5._fesErrorMonitor(err); }
printFriendlyStack
```
##### 文法
````JavaScript
```javascript
fesErrorMonitor(event)
````
```
##### パラメータ
```
@param {*} e エラーイベント
```
###
<ins>内部エラーの例 1</ins>
```JavaScript
```javascript
function preload() {
// プリロードでのbackground()の呼び出しにより発生します。
// 間違い
Expand All @@ -279,7 +279,7 @@ FES将在控制台中生成以下消息:
> 🌸 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)
<ins>内部エラーの例 2</ins>
```JavaScript
```javascript
function setup() {
cnv = createCanvas(200, 200);
cnv.mouseClicked();
Expand All @@ -289,7 +289,7 @@ FES将在控制台中生成以下消息:
> 🌸 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)
<ins>ユーザー例のスコープエラーの例</ins>
```JavaScript
```javascript
function setup() {
let b = 1;
}
Expand All @@ -300,7 +300,7 @@ function draw() {
> 🌸 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
<ins>ユーザー例のタイプミスの例</ins>
```JavaScript
```javascript
function setup() {
colour(1, 2, 3);
}
Expand All @@ -327,22 +327,22 @@ core/friendly_errors/fes_core.js

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

##### 文法
````JavaScript
```javascript
checkForUserDefinedFunctions(context)
````
```
##### 引数
```
@param {*} context 現在のデフォルトのコンテキスト。
「グローバル モード」ではウィンドウに設定し、「インスタンス モード」では p5 インスタンスに設定します。
```
#####
````JavaScript
```javascript
function preLoad() {
loadImage('myimage.png');
}
````
```
FESはコンソールに以下のメッセージを生成します:
> 🌸 p5.jsのヒント:preLoadと書くべきところをpreloadと誤って書いているようです。これが意図していない場合は、訂正してください。(http://p5js.org/reference/#/p5/preload)
Expand Down Expand Up @@ -413,7 +413,7 @@ p5.newObject = function(parameter) {
this.parameter = 'some parameter';
this.name = 'p5.newObject';
};
````
```
* インラインドキュメント:許可されるパラメータタイプには`Boolean``Number``String`、およびオブジェクトの名前が含まれます(上記の箇条書きを参照)。任意の配列パラメータには`Array`を使用してください。必要に応じて、説明部分で許可される特定のタイプの配列パラメータ(例:`Number[]``String[]`)を解説できます。
* 現在サポートされているクラスタイプ(それぞれの`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`

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


```JavaScript
```javascript
p5.disableFriendlyErrors = true; // FESを無効にする

function setup() {
Expand All @@ -441,7 +441,7 @@ function draw() {
## 既知の制限

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

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

* `sketch_reader.js`は拡張可能で、新しい機能を追加することができます(例:ユーザーが`draw()`関数内で変数を宣言したときに警告を発する)。ユーザーをよりよく支援するためです。
```JavaScript
```javascript
// 这段代码片段使用新函数包装了 window.console 方法,以修改其功能
// 目前尚未实现,但可以使用它来提供更好格式的错误消息
const original = window.console;
Expand Down
8 changes: 4 additions & 4 deletions contributor_docs/ja/friendly_error_system.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ i18next は補間をサポートしているため、変数を渡してメッセ
ここで、キーは「greeting」、変数名は「who」です。

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

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

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

例:
```JavaScript
```javascript
p5.disableFriendlyErrors = true;

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

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

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

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

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

````javascript
```javascript
p5.newObject = function(parameter) {
this.parameter = '파라미터';
this.name = 'p5.newObject';
};
````
```
* 인라인 문서: 허용되는 파라미터 타입은 `Boolean`, `Number`, `String`, 그리고 객체의 이름(위의 주요 항목 참고)입니다. 유형에 관계없이 배열 파라미터에는 `Array` 를 쓰세요. 필요한 경우, 어떤 특정 타입의 배열 파라미터가 허용되는지(예시 `Number[]`, `String[]`) 설명 섹션에 적습니다.
* 현재 지원되는 클래스 타입은 이렇습니다( `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`.

Expand Down
Loading

0 comments on commit d539cf3

Please sign in to comment.