Updated docs to reflect that getEntry returns undefined #10688

hkbertoson · 2025-01-10T17:28:25Z

Description (required)

Updated Content Collections to reflect that getEntry returns undefined.
Feedback is greatly appreciated since I am still fairly new on writing documention.

Related issues & labels (optional)

Closes #
Suggested label:

astrobot-houston · 2025-01-10T17:28:55Z

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File	Note
en/guides/content-collections.mdx	Source changed, localizations will be marked as outdated.
en/reference/modules/astro-content.mdx	Source changed, localizations will be marked as outdated.

Warnings reference

Icon	Description
🔄️	The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

netlify · 2025-01-10T17:28:59Z

✅ Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`eaed64a`
🔍 Latest deploy log	https://app.netlify.com/sites/astro-docs-2/deploys/678e554349f1b60008d9f6f0
😎 Deploy Preview	https://deploy-preview-10688--astro-docs-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

sarah11918 · 2025-01-10T17:49:09Z

Thanks for identifying an issue and bringing it up @hkbertoson

I'll ask @ascorbic to weigh in here, because I really don't love that our "basic, here's what it looks like" example has error checks and even different ways to do things in it! I don't think the guide page is the place for this unless we absolutely expect all of that to be written every time someone renders content. @ascorbic , is that really the idea?

We could have a line or section that mentions you may want to consider error handling/checking for entries, with its own separate example. Or, this just links to the reference page where we add a section on how to do this.

But, this seems wrong as "Here's how you do this!" unless this really is "how we expect you to do it, every time, checking for whether things exist first." So I'll need Matt to let me know how he wants to guide people to use the feature! Hang tight Hunter until he gives his guidance! 🙌

hkbertoson · 2025-01-10T17:50:48Z

Sure thing. Thanks! @sarah11918

sarah11918

On Talking and Doc'ing we discussed how to include this in a minimal, helpful way. We think this, plus adding to the type reference that getEntry() can returned undefined should be sufficient!

src/content/docs/en/guides/content-collections.mdx

src/content/docs/en/reference/modules/astro-content.mdx

Co-authored-by: Sarah Rainsberger <[email protected]>

sarah11918

Thanks so much for this great improvement @hkbertoson ! It's so appreciated that experiences from support threads make it into docs! 🙌

Fryuni · 2025-01-16T17:16:33Z

src/content/docs/en/reference/modules/astro-content.mdx

@@ -147,7 +147,7 @@ const draftBlogPosts = await getCollection('blog', ({ data }) => {

 <p>

-**Type:** `( collection: string, id: string ) => CollectionEntry<collection> | ({ collection: string, id: string }) => CollectionEntry<collection>`
+**Type:** `((collection: string, id: string) => Promise<CollectionEntry<collection> | undefined>) | (({ collection: string, id: string }) => Promise<CollectionEntry<collection> | undefined>)`


This might be too big to be legible in a single line. Do we have a multi-line syntax for types anywhere that we could replicate here?

Not really unfortunately. The usual pattern we’d follow instead would be to have something like **Type:** [`TypeName`](#typename) and show it as a type in a code block with a subheading. But usually that’s for things like options interfaces etc., not just a function type.

@ArmandPhilippot Can you think of an example off the top of your head? On desktop for me, it looks like this:

I think one problem is I'm not convinced that each of those two pieces will themselves fit on their own single line, so it's going to look icky either way. But, happy for someone to suggest something that they can figure out that looks good!

Also happy for any maintainer to merge once they either have improved, or resigned themselves to, the above! 😅

Yeah I see the same thing but... not really, no. Can we drop support for Legacy collections? 😆 Another "solution" would be to use a list under Type: so that each is on its own line... (instead of the union) but that's not ideal either.

I have a little more time than before, so I took the opportunity to take a screenshot to illustrate what I was saying:

I don't have a strong opinion on this... I'm not sure what is more readable/understandable.

Edit: Well, it seems you also have thought about that ("on their own single line, so it's going to look icky either way.")... Not my day. 😄

I mean, I guess that's better? What does everyone think? I'm fine with 2 lines (which unfortunately looks like it's gonna be 3 in practice?) Not opposed to the bullet points here!

LGTM, way more readable

sarah11918

@ArmandPhilippot Happy for you to make the two line change and merge!

src/content/docs/en/reference/modules/astro-content.mdx

Signed-off-by: Thomas Bonnet <[email protected]>

…#10688 Signed-off-by: Thomas Bonnet <[email protected]>

…10741) Co-authored-by: Armand Philippot <[email protected]>

Co-authored-by: Armand Philippot <[email protected]>

Updated docs to reflect that getEntry returns undefined

b0a0c0b

sarah11918 added improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) should this be documented? Need to figure out whether this is something to add to documentation or not labels Jan 13, 2025

sarah11918 reviewed Jan 16, 2025

View reviewed changes

sarah11918 and others added 3 commits January 16, 2025 09:49

getEntry type update

3840baf

Apply suggestions from talking and doc'ing review

005afcb

Merge branch 'main' into fix/update-content-collections

1aac9fd

sarah11918 removed the should this be documented? Need to figure out whether this is something to add to documentation or not label Jan 16, 2025

Merge branch 'main' into fix/update-content-collections

3665213

sarah11918 reviewed Jan 16, 2025

View reviewed changes

src/content/docs/en/reference/modules/astro-content.mdx Outdated Show resolved Hide resolved

Update astro-content.mdx

c6ff4cc

Co-authored-by: Sarah Rainsberger <[email protected]>

sarah11918 approved these changes Jan 16, 2025

View reviewed changes

Merge branch 'main' into fix/update-content-collections

9db152e

sarah11918 added the Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! label Jan 16, 2025

louisescher approved these changes Jan 16, 2025

View reviewed changes

Fryuni approved these changes Jan 16, 2025

View reviewed changes

sarah11918 approved these changes Jan 20, 2025

View reviewed changes

ArmandPhilippot reviewed Jan 20, 2025

View reviewed changes

src/content/docs/en/reference/modules/astro-content.mdx Outdated Show resolved Hide resolved

ArmandPhilippot added 2 commits January 20, 2025 14:45

use a list to display getEntry types

8c424fa

Merge branch 'main' into fix/update-content-collections

eaed64a

ArmandPhilippot merged commit 24ded70 into withastro:main Jan 20, 2025
10 checks passed

This was referenced Jan 21, 2025

i18n(ko-KR): update documents about content collections #10737

Merged

i18n(ko-KR): update astro-content.mdx #10738

Closed

thomasbnt added a commit to thomasbnt/docs that referenced this pull request Jan 21, 2025

i18n(fr): Update guides/content-collection.mdx from withastro#10688

5f544c3

Signed-off-by: Thomas Bonnet <[email protected]>

thomasbnt mentioned this pull request Jan 21, 2025

i18n(fr): Update guides/content-collection.mdx from #10688 #10740

Merged

thomasbnt added a commit to thomasbnt/docs that referenced this pull request Jan 21, 2025

i18n(fr): Update reference/modules/astro-content.mdx from withastro…

462af53

…#10688 Signed-off-by: Thomas Bonnet <[email protected]>

thomasbnt mentioned this pull request Jan 21, 2025

i18n(fr): Update reference/modules/astro-content.mdx from #10688 #10741

Merged

thomasbnt added a commit that referenced this pull request Jan 21, 2025

i18n(fr): Update reference/modules/astro-content.mdx from #10688 (#…

92b6425

…10741) Co-authored-by: Armand Philippot <[email protected]>

thomasbnt added a commit that referenced this pull request Jan 21, 2025

i18n(fr): Update guides/content-collection.mdx from #10688 (#10740)

92ba828

Co-authored-by: Armand Philippot <[email protected]>

Nin3lee mentioned this pull request Jan 23, 2025

i18n(zh-cn): Add content-loader-reference.mdx & Update related docs #10763

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated docs to reflect that getEntry returns undefined #10688

Updated docs to reflect that getEntry returns undefined #10688

hkbertoson commented Jan 10, 2025

astrobot-houston commented Jan 10, 2025 •

edited

Loading

netlify bot commented Jan 10, 2025 •

edited

Loading

sarah11918 commented Jan 10, 2025 •

edited

Loading

hkbertoson commented Jan 10, 2025

sarah11918 left a comment

sarah11918 left a comment

Fryuni Jan 16, 2025

delucis Jan 16, 2025

sarah11918 Jan 16, 2025

sarah11918 Jan 16, 2025

ArmandPhilippot Jan 16, 2025

ArmandPhilippot Jan 16, 2025 •

edited

Loading

sarah11918 Jan 17, 2025

louisescher Jan 17, 2025

delucis Jan 17, 2025

sarah11918 left a comment

Updated docs to reflect that getEntry returns undefined #10688

Updated docs to reflect that getEntry returns undefined #10688

Conversation

hkbertoson commented Jan 10, 2025

Description (required)

Related issues & labels (optional)

astrobot-houston commented Jan 10, 2025 • edited Loading

Lunaria Status Overview

Tracked Files

netlify bot commented Jan 10, 2025 • edited Loading

✅ Deploy Preview for astro-docs-2 ready!

sarah11918 commented Jan 10, 2025 • edited Loading

hkbertoson commented Jan 10, 2025

sarah11918 left a comment

Choose a reason for hiding this comment

sarah11918 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ArmandPhilippot Jan 16, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sarah11918 left a comment

Choose a reason for hiding this comment

astrobot-houston commented Jan 10, 2025 •

edited

Loading

netlify bot commented Jan 10, 2025 •

edited

Loading

sarah11918 commented Jan 10, 2025 •

edited

Loading

ArmandPhilippot Jan 16, 2025 •

edited

Loading