p5.js-web-editor icon indicating copy to clipboard operation
p5.js-web-editor copied to clipboard

Add `describe()` to default sketch

Open catarak opened this issue 3 years ago • 1 comments

Nature of issue?

  • New feature request

New feature details:

As suggested in https://github.com/processing/p5.js/issues/5427, adding describe() would hopefully encourage folks to add a description to their sketches. We could also think about having different descriptions for each of the different translations.

catarak avatar Nov 03 '21 18:11 catarak

@catarak I got started on this issue but am not too sure how translations work -- having descriptions in different languages is a great idea!

I think I should read up on i18next and figure out how to apply it along the lines of the following snippet.

import i18next from 'i18next';

const description = i18next.t('DefaultSketch.Description');

const defaultSketch = `function setup() {
  createCanvas(400, 400);
}

function draw() {
  background(220);
  describe('${description}');
}`;

Does that seem like a route forward? Happy to test with /translations/locales/es-419/translations.json.

nickmcintyre avatar Nov 05 '21 15:11 nickmcintyre

hey @raclim is this issue still open to work as there is one PR

parteekcoder avatar Feb 27 '23 10:02 parteekcoder

hey @raclim can you please describe about this issue more as It is not clear from above discussion what is exactly required

parteekcoder avatar Feb 27 '23 10:02 parteekcoder

Thanks @parteekcoder for your interest in working on it. Let's revisit this issue after the describe() guideline is completed in processing/p5.js#6387

Qianqianye avatar Sep 02 '23 01:09 Qianqianye