From ad37af81eac08d25d320392e851ae1b6c0c7703f Mon Sep 17 00:00:00 2001 From: Dave Pagurek Date: Fri, 10 May 2024 14:58:18 -0400 Subject: [PATCH 1/5] Fix class methods getting added to subcategories --- src/layouts/ReferenceLayout.astro | 1 + 1 file changed, 1 insertion(+) diff --git a/src/layouts/ReferenceLayout.astro b/src/layouts/ReferenceLayout.astro index cea6e1f11c..ad5a0c0be3 100644 --- a/src/layouts/ReferenceLayout.astro +++ b/src/layouts/ReferenceLayout.astro @@ -99,6 +99,7 @@ const categoryData = categories.map((category) => { .filter( (e) => e.data.submodule === subcat && + (!e.data.class || e.data.class === 'p5') && !e.data.isConstructor && e.data.description !== "" ) From a59614fd2e45db6d625deee2098fe655dcd0d999 Mon Sep 17 00:00:00 2001 From: Dave Pagurek Date: Fri, 10 May 2024 15:17:40 -0400 Subject: [PATCH 2/5] Rename non-constant reference files to lowercase --- src/content/reference/en/p5/{BLEND.mdx => blend.mdx} | 0 src/content/reference/en/p5/{CHAR.mdx => char.mdx} | 0 src/content/reference/en/p5/{DEGREES.mdx => degrees.mdx} | 0 src/content/reference/en/p5/{FLOAT.mdx => float.mdx} | 0 src/content/reference/en/p5/{IMAGE.mdx => image.mdx} | 0 src/content/reference/en/p5/{RADIANS.mdx => radians.mdx} | 0 src/content/reference/en/p5/{REMOVE.mdx => remove.mdx} | 0 src/content/reference/en/p5/{RETURN.mdx => return.mdx} | 0 src/content/reference/en/p5/{ROUND.mdx => round.mdx} | 0 src/content/reference/en/p5/{TEXT.mdx => text.mdx} | 0 src/content/reference/en/p5/{TEXTURE.mdx => texture.mdx} | 0 src/content/reference/es/p5/{TEXTURE.mdx => texture.mdx} | 0 src/content/reference/hi/p5/{TEXT.mdx => text.mdx} | 0 src/content/reference/hi/p5/{TEXTURE.mdx => texture.mdx} | 0 src/content/reference/ko/p5/{TEXTURE.mdx => texture.mdx} | 0 15 files changed, 0 insertions(+), 0 deletions(-) rename src/content/reference/en/p5/{BLEND.mdx => blend.mdx} (100%) rename src/content/reference/en/p5/{CHAR.mdx => char.mdx} (100%) rename src/content/reference/en/p5/{DEGREES.mdx => degrees.mdx} (100%) rename src/content/reference/en/p5/{FLOAT.mdx => float.mdx} (100%) rename src/content/reference/en/p5/{IMAGE.mdx => image.mdx} (100%) rename src/content/reference/en/p5/{RADIANS.mdx => radians.mdx} (100%) rename src/content/reference/en/p5/{REMOVE.mdx => remove.mdx} (100%) rename src/content/reference/en/p5/{RETURN.mdx => return.mdx} (100%) rename src/content/reference/en/p5/{ROUND.mdx => round.mdx} (100%) rename src/content/reference/en/p5/{TEXT.mdx => text.mdx} (100%) rename src/content/reference/en/p5/{TEXTURE.mdx => texture.mdx} (100%) rename src/content/reference/es/p5/{TEXTURE.mdx => texture.mdx} (100%) rename src/content/reference/hi/p5/{TEXT.mdx => text.mdx} (100%) rename src/content/reference/hi/p5/{TEXTURE.mdx => texture.mdx} (100%) rename src/content/reference/ko/p5/{TEXTURE.mdx => texture.mdx} (100%) diff --git a/src/content/reference/en/p5/BLEND.mdx b/src/content/reference/en/p5/blend.mdx similarity index 100% rename from src/content/reference/en/p5/BLEND.mdx rename to src/content/reference/en/p5/blend.mdx diff --git a/src/content/reference/en/p5/CHAR.mdx b/src/content/reference/en/p5/char.mdx similarity index 100% rename from src/content/reference/en/p5/CHAR.mdx rename to src/content/reference/en/p5/char.mdx diff --git a/src/content/reference/en/p5/DEGREES.mdx b/src/content/reference/en/p5/degrees.mdx similarity index 100% rename from src/content/reference/en/p5/DEGREES.mdx rename to src/content/reference/en/p5/degrees.mdx diff --git a/src/content/reference/en/p5/FLOAT.mdx b/src/content/reference/en/p5/float.mdx similarity index 100% rename from src/content/reference/en/p5/FLOAT.mdx rename to src/content/reference/en/p5/float.mdx diff --git a/src/content/reference/en/p5/IMAGE.mdx b/src/content/reference/en/p5/image.mdx similarity index 100% rename from src/content/reference/en/p5/IMAGE.mdx rename to src/content/reference/en/p5/image.mdx diff --git a/src/content/reference/en/p5/RADIANS.mdx b/src/content/reference/en/p5/radians.mdx similarity index 100% rename from src/content/reference/en/p5/RADIANS.mdx rename to src/content/reference/en/p5/radians.mdx diff --git a/src/content/reference/en/p5/REMOVE.mdx b/src/content/reference/en/p5/remove.mdx similarity index 100% rename from src/content/reference/en/p5/REMOVE.mdx rename to src/content/reference/en/p5/remove.mdx diff --git a/src/content/reference/en/p5/RETURN.mdx b/src/content/reference/en/p5/return.mdx similarity index 100% rename from src/content/reference/en/p5/RETURN.mdx rename to src/content/reference/en/p5/return.mdx diff --git a/src/content/reference/en/p5/ROUND.mdx b/src/content/reference/en/p5/round.mdx similarity index 100% rename from src/content/reference/en/p5/ROUND.mdx rename to src/content/reference/en/p5/round.mdx diff --git a/src/content/reference/en/p5/TEXT.mdx b/src/content/reference/en/p5/text.mdx similarity index 100% rename from src/content/reference/en/p5/TEXT.mdx rename to src/content/reference/en/p5/text.mdx diff --git a/src/content/reference/en/p5/TEXTURE.mdx b/src/content/reference/en/p5/texture.mdx similarity index 100% rename from src/content/reference/en/p5/TEXTURE.mdx rename to src/content/reference/en/p5/texture.mdx diff --git a/src/content/reference/es/p5/TEXTURE.mdx b/src/content/reference/es/p5/texture.mdx similarity index 100% rename from src/content/reference/es/p5/TEXTURE.mdx rename to src/content/reference/es/p5/texture.mdx diff --git a/src/content/reference/hi/p5/TEXT.mdx b/src/content/reference/hi/p5/text.mdx similarity index 100% rename from src/content/reference/hi/p5/TEXT.mdx rename to src/content/reference/hi/p5/text.mdx diff --git a/src/content/reference/hi/p5/TEXTURE.mdx b/src/content/reference/hi/p5/texture.mdx similarity index 100% rename from src/content/reference/hi/p5/TEXTURE.mdx rename to src/content/reference/hi/p5/texture.mdx diff --git a/src/content/reference/ko/p5/TEXTURE.mdx b/src/content/reference/ko/p5/texture.mdx similarity index 100% rename from src/content/reference/ko/p5/TEXTURE.mdx rename to src/content/reference/ko/p5/texture.mdx From 20a6a939ab856507a6680cf795687d7d78de613b Mon Sep 17 00:00:00 2001 From: Dave Pagurek Date: Fri, 10 May 2024 15:30:15 -0400 Subject: [PATCH 3/5] Don't repeat shared params from previous overloads --- src/layouts/ReferenceItemLayout.astro | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/src/layouts/ReferenceItemLayout.astro b/src/layouts/ReferenceItemLayout.astro index 8aac514918..ce5a57e24e 100644 --- a/src/layouts/ReferenceItemLayout.astro +++ b/src/layouts/ReferenceItemLayout.astro @@ -71,6 +71,9 @@ const relatedReferences = [ ...relatedReferencesFromEntryData, ...relatedEntries, ].slice(0, 4); + +const seenParams: Record = {}; + --- @@ -134,15 +137,19 @@ const relatedReferences = [ ))} {entry.data.overloads && entry.data.overloads.map((overload: ReferenceOverload) => - overload.params.map((param: ReferenceParam) => ( -
-

{param.name}

- -
- )) + overload.params.map((param: ReferenceParam) => { + if (seenParams[param.name]) return <>; + seenParams[param.name] = true; + return ( +
+

{param.name}

+ +
+ ) + }) )} From 93223ac22d07b541c61abc9f49d0a8691234e13a Mon Sep 17 00:00:00 2001 From: Dave Pagurek Date: Fri, 10 May 2024 15:44:33 -0400 Subject: [PATCH 4/5] Show type in parameters --- src/layouts/ReferenceItemLayout.astro | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/layouts/ReferenceItemLayout.astro b/src/layouts/ReferenceItemLayout.astro index ce5a57e24e..958e10d1f9 100644 --- a/src/layouts/ReferenceItemLayout.astro +++ b/src/layouts/ReferenceItemLayout.astro @@ -143,10 +143,12 @@ const seenParams: Record = {}; return (

{param.name}

- +
+ {param.type && {param.type}: } + +
) }) From 0d38ed62b955c0b1135320f57a6f22757a5f21d4 Mon Sep 17 00:00:00 2001 From: Dave Pagurek Date: Fri, 10 May 2024 15:54:50 -0400 Subject: [PATCH 5/5] Put back rich descriptions in class methods/properties --- src/layouts/ReferenceItemLayout.astro | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/src/layouts/ReferenceItemLayout.astro b/src/layouts/ReferenceItemLayout.astro index 958e10d1f9..75579912cf 100644 --- a/src/layouts/ReferenceItemLayout.astro +++ b/src/layouts/ReferenceItemLayout.astro @@ -175,10 +175,7 @@ const seenParams: Record = {}; > {key} - {/* We don't render the full HTML in the preview */} -

- {propertyValue.description.replace(/<[^>]*>/g, "")} -

+
); })} @@ -203,10 +200,7 @@ const seenParams: Record = {}; > {key} - {/* We don't render the full HTML in the preview */} -

- {methodValue.description.replace(/<[^>]*>/g, "")} -

+
); })}