processing / p5.js-website

New p5.js website!

Home Page:http://p5js.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

On the reference page, p5.Image methods are duplicated

davepagurek opened this issue · comments

On https://beta.p5js.org/reference/#Image, the first subsection (just labelled "Image") seems to have the same content as the last subsection (labelled "p5.Image".) This doesn't happen for every subsection from a class (e.g. p5.Geometry doesn't have this problem.)

I need to look into whether or not this is something we can fix in the UI or whether it requires a data change. Leaving this issue here so I don't forget about it.

This is mainly because the one directly under Image is the functions that is called as is and act on the main canvas, whereas for those under p5.Image acts against p5.Image object instance (ie. img.filter()). I'm not sure a data change will make sense here and probably a UI change for object instance methods to make it clear what they are will work better.

Ah ok so the methods are all valid? They still link to the same URLs that include p5.Image, that's probably in need of fixing at least

Yup, they are essentially this page and this page respectively. The contents are very similar as well.

Wait, actually those do still exist but in the pixels category a little below. It looks like that first section really is just a duplicate?

There's something not quite right going on here. blend() under pixels actually links to the constant BLEND.

There was some discussion before about the naming collision between constants and methods, what was the result of that? I wonder if that incorrect link could be related

I think I've got a fix, I'll put up a PR soon. Also just noticing that when a method has multiple overloads with shared parameter names, it duplicates the shared names but without a description:

image

vs on the current site:

image

I'll address that too.