You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
FES will generate the following message in the console:
250
250
251
251
```
252
-
🌸 p5.js says: [sketch.js, line 14] arc() was expecting Number for the first parameter, received string instead. (http://p5js.org/reference/#/p5/arc)
252
+
🌸 p5.js says: [sketch.js, line 14] arc() was expecting Number for the first parameter, received string instead. (http://p5js.org/reference/p5/arc)
253
253
```
254
254
255
255
#### Location
@@ -323,7 +323,7 @@ function preload() {
323
323
FES will generate the following message in the console:
324
324
325
325
```
326
-
🌸 p5.js says: [sketch.js, line 8] An error with message "Cannot read properties of undefined (reading 'background')" occurred inside the p5js library when "background" was called. If not stated otherwise, it might be due to "background" being called from preload. Nothing besides load calls (loadImage, loadJSON, loadFont, loadStrings, etc.) should be inside the preload function. (http://p5js.org/reference/#/p5/preload)
326
+
🌸 p5.js says: [sketch.js, line 8] An error with message "Cannot read properties of undefined (reading 'background')" occurred inside the p5js library when "background" was called. If not stated otherwise, it might be due to "background" being called from preload. Nothing besides load calls (loadImage, loadJSON, loadFont, loadStrings, etc.) should be inside the preload function. (http://p5js.org/reference/p5/preload)
327
327
```
328
328
329
329
Internal Error Example 2:
@@ -338,7 +338,7 @@ function setup() {
338
338
FES will generate the following message in the console:
339
339
340
340
```js
341
-
🌸 p5.js says: [sketch.js, line 12] An error with message "Cannot read properties of undefined (reading 'bind')" occurred inside the p5js library when mouseClicked was called. If not stated otherwise, it might be an issue with the arguments passed to mouseClicked. (http://p5js.org/reference/#/p5/mouseClicked)
341
+
🌸 p5.js says: [sketch.js, line 12] An error with message "Cannot read properties of undefined (reading 'bind')" occurred inside the p5js library when mouseClicked was called. If not stated otherwise, it might be an issue with the arguments passed to mouseClicked. (http://p5js.org/reference/p5/mouseClicked)
342
342
```
343
343
344
344
Example of an Error (Scope):
@@ -373,7 +373,7 @@ function setup() {
373
373
FES will generate the following message in the console:
374
374
375
375
```
376
-
🌸 p5.js says: [sketch.js, line 2] It seems that you may have accidentally written "xolor" instead of"color". Please correct it to color if you wish to use the function from p5.js. (http://p5js.org/reference/#/p5/color)
376
+
🌸 p5.js says: [sketch.js, line 2] It seems that you may have accidentally written "xolor" instead of"color". Please correct it to color if you wish to use the function from p5.js. (http://p5js.org/reference/p5/color)
377
377
```
378
378
379
379
#### Location
@@ -413,7 +413,7 @@ function preload() {
413
413
FES will generate the following message in the console:
414
414
415
415
```
416
-
🌸 p5.jssays:ItseemsthatyoumayhaveaccidentallywrittenpreLoadinsteadofpreload. Pleasecorrectitifit's not intentional. (http://p5js.org/reference/#/p5/preload)
416
+
🌸 p5.jssays:ItseemsthatyoumayhaveaccidentallywrittenpreLoadinsteadofpreload. Pleasecorrectitifit's not intentional. (http://p5js.org/reference/p5/preload)
Copy file name to clipboardExpand all lines: src/content/contributor-docs/en/how-to-add-friendly-error-messages.mdx
+6-6
Original file line number
Diff line number
Diff line change
@@ -123,9 +123,9 @@ circle(100, 100, 'hello');
123
123
The code above should generate the following FE messages:
124
124
125
125
```
126
-
🌸 p5.js says: [sketch.js, line 9] circle() was expecting at least 3 arguments, but received only 1. (http://p5js.org/reference/#/p5/circle)
127
-
🌸 p5.js says: [sketch.js, line 14] circle() was expecting no more than 3 arguments, but received 4. (http://p5js.org/reference/#/p5/circle)
128
-
🌸 p5.js says: [sketch.js, line 12] circle() was expecting Number for the third parameter, received string instead. (http://p5js.org/reference/#/p5/circle)
126
+
🌸 p5.js says: [sketch.js, line 9] circle() was expecting at least 3 arguments, but received only 1. (http://p5js.org/reference/p5/circle)
127
+
🌸 p5.js says: [sketch.js, line 14] circle() was expecting no more than 3 arguments, but received 4. (http://p5js.org/reference/p5/circle)
128
+
🌸 p5.js says: [sketch.js, line 12] circle() was expecting Number for the third parameter, received string instead. (http://p5js.org/reference/p5/circle)
129
129
```
130
130
131
131
Congratulations 🎈! You are now done adding parameter validation for your new method.
@@ -240,7 +240,7 @@ p5._friendlyError(
240
240
This should generate the following FE messages:
241
241
242
242
```
243
-
🌸 p5.js says: [sketch.js, line 19] An error with the message "vertex() must be used once before calling bezierVertex()" occurred inside the p5js library when bezierVertex was called. If not stated otherwise, it might be an issue with the arguments passed to bezierVertex. (http://p5js.org/reference/#/p5/bezierVertex)
243
+
🌸 p5.js says: [sketch.js, line 19] An error with the message "vertex() must be used once before calling bezierVertex()" occurred inside the p5js library when bezierVertex was called. If not stated otherwise, it might be an issue with the arguments passed to bezierVertex. (http://p5js.org/reference/p5/bezierVertex)
244
244
```
245
245
246
246
Congratulations 🎈! You are now done adding library error messages for your method.
@@ -250,13 +250,13 @@ Congratulations 🎈! You are now done adding library error messages for your me
250
250
FES message writers should prioritize lowering the barrier of understanding error messages and increasing the accessibility of the debugging process. Here is one example:
251
251
252
252
```
253
-
🌸 p5.js says: [sketch.js, line 7] circle() was expecting at least 3 arguments, but received only 1. (http://p5js.org/reference/#/p5/circle)
253
+
🌸 p5.js says: [sketch.js, line 7] circle() was expecting at least 3 arguments, but received only 1. (http://p5js.org/reference/p5/circle)
254
254
```
255
255
256
256
The above parameter validation message will be shown in Korean if the browser is set to `ko-KR` (Korean) locale:
257
257
258
258
```
259
-
🌸 p5.js says: [sketch.js, 줄7] 최소 3개의 인수(argument)를 받는 함수 circle()에 인수가 1개만 입력되었습니다. (http://p5js.org/reference/#/p5/circle)
259
+
🌸 p5.js says: [sketch.js, 줄7] 최소 3개의 인수(argument)를 받는 함수 circle()에 인수가 1개만 입력되었습니다. (http://p5js.org/reference/p5/circle)
260
260
```
261
261
262
262
[Friendly Errors i18n Book](https://almchung.github.io/p5-fes-i18n-book/) discusses challenges and best practices for writing Friendly Error messages within the cross-cultural i18n context. Here are the main points from the book:
Copy file name to clipboardExpand all lines: src/content/contributor-docs/en/release_process.mdx
+1-1
Original file line number
Diff line number
Diff line change
@@ -53,7 +53,7 @@ CDNs will take a bit more time (a day or two) to update but they will automatica
53
53
54
54
## What's actually happening
55
55
56
-
The GitHub Action ["New p5.js release"](../.github/workflows/release.yml) is triggered on a tag that matches the pattern `v*.*.*` which is created by the `npm version ___` command.
56
+
The GitHub Action ["New p5.js release"](../.github/workflows/release-workflow.yml) is triggered on a tag that matches the pattern `v*.*.*` which is created by the `npm version ___` command.
Copy file name to clipboardExpand all lines: src/content/contributor-docs/es/contributing_to_the_p5js_reference.mdx
+2-2
Original file line number
Diff line number
Diff line change
@@ -77,7 +77,7 @@ Cualquier cosa en un bloque de estos se interpretará como documentación de ref
77
77
78
78
## Bloque de comentarios de referencia
79
79
80
-
Desglosemos el bloque de comentarios de referencia anterior para la función `sin()` y veamos qué hace cada sección. Puedes comparar lo que vez en estos comentarios con el contenido de la página de referencia para [`sin()`](https://p5js.org/reference/#/p5/sin/).
80
+
Desglosemos el bloque de comentarios de referencia anterior para la función `sin()` y veamos qué hace cada sección. Puedes comparar lo que vez en estos comentarios con el contenido de la página de referencia para [`sin()`](https://p5js.org/reference/p5/sin/).
81
81
82
82
```
83
83
/**
@@ -268,7 +268,7 @@ Si no quieres que el ejemplo se ejecute como parte de las pruebas automatizadas
268
268
* </code></div>
269
269
```
270
270
271
-
Si tu ejemplo utiliza archivos externos como recursos, colócalos en la carpeta [/docs/yuidoc-p5-theme/assets](https://github.com/processing/p5.js/tree/main/docs/yuidoc-p5-theme/assets/) (o reutiliza uno que ya esté allí) y luego enlázalos con "assets/nombrearchivo.ext" en el código. Consulta la referencia de [tint()](http://p5js.org/reference/#/p5/tint/) como ejemplo.
271
+
Si tu ejemplo utiliza archivos externos como recursos, colócalos en la carpeta [/docs/yuidoc-p5-theme/assets](https://github.com/processing/p5.js/tree/main/docs/yuidoc-p5-theme/assets/) (o reutiliza uno que ya esté allí) y luego enlázalos con "assets/nombrearchivo.ext" en el código. Consulta la referencia de [tint()](http://p5js.org/reference/p5/tint/) como ejemplo.
272
272
273
273
### Agregar descripción a un lienzo usando `describe()`
Copy file name to clipboardExpand all lines: src/content/contributor-docs/hi/contributing_to_the_p5js_reference.mdx
+2-2
Original file line number
Diff line number
Diff line change
@@ -77,7 +77,7 @@ p5.js के स्रोत कोड को देखने पर, आपक
77
77
78
78
## संदर्भ टिप्पणी ब्लॉक
79
79
80
-
ऊपर दिए गए `sin()` फ़ंक्शन के लिए संदर्भ टिप्पणियों ब्लॉक को विश्लेषित करें और देखें कि प्रत्येक खंड का क्या काम है। आप यहाँ टिप्पणियों में दिखने वाली जानकारी और `sin()` के संदर्भ पृष्ठ पर जो दिखता है, उनकी तुलना कर सकते हैं। ([`sin()`](https://p5js.org/reference/#/p5/sin/))
80
+
ऊपर दिए गए `sin()` फ़ंक्शन के लिए संदर्भ टिप्पणियों ब्लॉक को विश्लेषित करें और देखें कि प्रत्येक खंड का क्या काम है। आप यहाँ टिप्पणियों में दिखने वाली जानकारी और `sin()` के संदर्भ पृष्ठ पर जो दिखता है, उनकी तुलना कर सकते हैं। ([`sin()`](https://p5js.org/reference/p5/sin/))
81
81
82
82
```
83
83
/**
@@ -268,7 +268,7 @@ p5.js के स्रोत कोड को देखने पर, आपक
268
268
* </code></div>
269
269
```
270
270
271
-
यदि आपका उदाहरण बाहरी संसाधन फ़ाइलों का उपयोग करता है, तो उन्हें [/docs/yuidoc-p5-theme/assets](https://github.com/processing/p5.js/tree/main/docs/yuidoc-p5-theme/assets/) फ़ोल्डर में रखें (या पहले से वहां मौजूद कोई उपयोग करें) फिर उन्हें कोड में "assets/filename.ext" के साथ लिंक करें। उदाहरण के लिए [tint()](http://p5js.org/reference/#/p5/tint/) संदर्भ देखें।
271
+
यदि आपका उदाहरण बाहरी संसाधन फ़ाइलों का उपयोग करता है, तो उन्हें [/docs/yuidoc-p5-theme/assets](https://github.com/processing/p5.js/tree/main/docs/yuidoc-p5-theme/assets/) फ़ोल्डर में रखें (या पहले से वहां मौजूद कोई उपयोग करें) फिर उन्हें कोड में "assets/filename.ext" के साथ लिंक करें। उदाहरण के लिए [tint()](http://p5js.org/reference/p5/tint/) संदर्भ देखें।
272
272
273
273
### `describe()` का उपयोग करके कैनवास का विवरण जोड़ें
Copy file name to clipboardExpand all lines: src/content/contributor-docs/ko/contributing_to_the_p5js_reference.mdx
+2-2
Original file line number
Diff line number
Diff line change
@@ -77,7 +77,7 @@ p5.js 소스 코드를 보면 많은 라인이 레퍼런스 주석으로 작성
77
77
78
78
## 레퍼런스 주석 블록
79
79
80
-
앞서 보았던 `sin()` 함수의 레퍼런스 주석 블록을 조금 더 자세히 살펴보고, 각 섹션이 어떤 역할을 하는지 알아봅시다. 주석으로 작성한 내용이 실제 [`sin()`](https://p5js.org/reference/#/p5/sin/) 레퍼런스 페이지에서는 어떻게 보여지는지 비교해보세요.
80
+
앞서 보았던 `sin()` 함수의 레퍼런스 주석 블록을 조금 더 자세히 살펴보고, 각 섹션이 어떤 역할을 하는지 알아봅시다. 주석으로 작성한 내용이 실제 [`sin()`](https://p5js.org/reference/p5/sin/) 레퍼런스 페이지에서는 어떻게 보여지는지 비교해보세요.
81
81
82
82
```
83
83
/**
@@ -268,7 +268,7 @@ p5.js 소스 코드를 보면 많은 라인이 레퍼런스 주석으로 작성
268
268
* </code></div>
269
269
```
270
270
271
-
만약, 예제 코드가 외부 애셋 파일을 사용해야 한다면, 필요한 파일들을 [/docs/yuidoc-p5-theme/assets](https://github.com/processing/p5.js/tree/main/docs/yuidoc-p5-theme/assets/) 폴더에 넣어두세요(이미 해당 폴더에 존재하는 파일을 재사용해도 됩니다). 그리고 코드에서 "assets/filename.ext" 경로로 파일을 불러와 사용하면 됩니다. [tint()](http://p5js.org/reference/#/p5/tint/) 레퍼런스를 참고하세요.
271
+
만약, 예제 코드가 외부 애셋 파일을 사용해야 한다면, 필요한 파일들을 [/docs/yuidoc-p5-theme/assets](https://github.com/processing/p5.js/tree/main/docs/yuidoc-p5-theme/assets/) 폴더에 넣어두세요(이미 해당 폴더에 존재하는 파일을 재사용해도 됩니다). 그리고 코드에서 "assets/filename.ext" 경로로 파일을 불러와 사용하면 됩니다. [tint()](http://p5js.org/reference/p5/tint/) 레퍼런스를 참고하세요.
***기여된 라이브러리는 제작자가 호스팅, 문서화 및 유지 관리합니다.** 라이브러리들은 GitHub, 별도의 웹 사이트 또는 어딘가에 있을 수 있습니다.
138
138
139
-
***문서가 핵심입니다!** 라이브러리 문서는 사용자가 쉽게 찾아보고 다운로드 하여 사용할 수 있는 곳에 있어야 합니다. 기여된 라이브러리에 대한 문서는 기본 p5.js 레퍼런스에 포함되지 않지만 여러분이 유사한 형식을 따르고 싶을 수도 있습니다. [라이브러리 개요 페이지](http://p5js.org/reference/#/libraries/p5.sound), [클래스 개요 페이지](http://p5js.org/reference/#/p5.Vector) 및 [메소드 페이지](http://p5js.org/reference/#/p5/arc/) 의 예제를 참조하세요.
139
+
***문서가 핵심입니다!** 라이브러리 문서는 사용자가 쉽게 찾아보고 다운로드 하여 사용할 수 있는 곳에 있어야 합니다. 기여된 라이브러리에 대한 문서는 기본 p5.js 레퍼런스에 포함되지 않지만 여러분이 유사한 형식을 따르고 싶을 수도 있습니다. [라이브러리 개요 페이지](http://p5js.org/reference/libraries/p5.sound), [클래스 개요 페이지](http://p5js.org/reference/p5.Vector) 및 [메소드 페이지](http://p5js.org/reference/p5/arc/) 의 예제를 참조하세요.
140
140
141
141
***예제가 좋습니다!** 사람들에게 라이브러리가 할 수 있는 일을 보여주세요. 모두 자바스크립트이므로 사람들은 라이브러리를 다운로드하기 전 온라인에서 실행 되는 것을 볼 수 있습니다. 예제들을 호스팅하기 쉬운
142
142
[jsfiddle](http://jsfiddle.net/) 및 [codepen](http://codepen.io)이라는 두가지 좋은 옵션이 있습니다.
0 commit comments