Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix typo #53

Merged
merged 2 commits into from
Feb 13, 2024
Merged

docs: fix typo #53

merged 2 commits into from
Feb 13, 2024

Conversation

ktym4a
Copy link
Contributor

@ktym4a ktym4a commented Feb 13, 2024

I feel these were typos and have corrected them.

Copy link

netlify bot commented Feb 13, 2024

Deploy Preview for astro-integration-kit ready!

Name Link
🔨 Latest commit 084fe4e
🔍 Latest deploy log https://app.netlify.com/sites/astro-integration-kit/deploys/65cb1cfcd3001d00081c19c2
😎 Deploy Preview https://deploy-preview-53--astro-integration-kit.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link
Owner

@florian-lefebvre florian-lefebvre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not against it, I just feel like it's a matter of personal preferences. I'm used to camelCase but why not PascalCase! Do you have a link to the zod docs where it's recommended or to several astro core/integrations using PascalCase? I'm just trying to see what's most used

@ktym4a
Copy link
Contributor Author

ktym4a commented Feb 13, 2024

oh, sorry.
I'm not saying something like that, just should be aligned with OptionsSchema or optionsSchema.
and if use PascalCase, it's okay for me.

here is current one

const OptionsSchema = z.object({
    foo: z.union([z.array(z.string()), z.literal(undefined)]).optional()
})

type Options = {
    /** An insightful comment */
    foo?: z.infer<typeof OptionsSchema>["foo"]
}

export default defineIntegration({
    setup({ options: inputOptions }) {
        const options = optionsSchema.parse(inputOptions);

        return {}
    }
})

@florian-lefebvre
Copy link
Owner

Sorry!! I actually completely misread your PR, was on phone 😅. Looking at https://github.com/withastro/starlight/blob/main/packages/starlight/utils/user-config.ts, I think we should use OptionsSchema as the variable name. Can you update line 88 instead?

@ktym4a
Copy link
Contributor Author

ktym4a commented Feb 13, 2024

I apologize for my lack of explanation! I changed it to PascalCase.

Copy link
Owner

@florian-lefebvre florian-lefebvre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks for contributing 🚀

@florian-lefebvre florian-lefebvre changed the title Refactor variable name docs: fix typo Feb 13, 2024
@florian-lefebvre florian-lefebvre merged commit 9e11c69 into florian-lefebvre:main Feb 13, 2024
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants