search

marko-js / tags-api-preview

Preview the Marko 6 "Tags API" in Marko 5!
MIT License
22 stars 7 forks source link

fix: compile error in README example #29

Closed leoj3n closed 1 year ago

leoj3n commented 2 years ago

Description

Example counter code from the README caused compile errors after copy+paste.

Adding a trailing slash to change <let/count=0> to <let/count=0/> resolves the error.

Motivation and Context

It is bad developer experience to copy a getting started example and have it not work. This may lead to new user attrition as they may think the tags API preview is suffering from a currently broken or incomplete implementation, when in fact it is a simple syntax error/typo in the sole primary example.

Screenshots (if appropriate):

image

Checklist:

changeset-bot[bot] commented 2 years ago

⚠️ No Changeset found

Latest commit: 8415020309e2dbcdd2cbaaf3c159910383617039

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

linux-foundation-easycla[bot] commented 2 years ago

CLA Signed

The committers listed above are authorized under a signed CLA.

DylanPiercey commented 2 years ago

Appreciate the PR @leoj3n and the additional test! Looks like the CI is failing though with the changes.

Will take a look soon!

codecov[bot] commented 1 year ago

Codecov Report

Base: 95.93% // Head: 95.93% // No change to project coverage :thumbsup:

Coverage data is based on head (8415020) compared to base (e1c209f). Patch has no changes to coverable lines.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #29 +/- ## ======================================= Coverage 95.93% 95.93% ======================================= Files 63 63 Lines 1033 1033 Branches 331 331 ======================================= Hits 991 991 Misses 14 14 Partials 28 28 ``` Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=marko-js). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=marko-js)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

leoj3n commented 1 year ago

Looks like for the failing format check git on the runner is not able to pull from origin to get the PR changes or something...

https://github.com/marko-js/tags-api-preview/actions/runs/3193771317/jobs/5213695521

Wonder if the runner is set up only to be able to pull from branches on this repo and not a forked repo or something?

Not too familiar with CI

DylanPiercey commented 1 year ago

@leoj3n I'm not sure what's going on with the format action, it seems to be working in other projects...

Regardless I think everything looks good here so I'm going to merge. Again appreciate this!