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

Fix syntax for theme command documentation #4651

Merged
merged 1 commit into from
Oct 17, 2024
Merged

Conversation

EvilGenius13
Copy link
Contributor

@EvilGenius13 EvilGenius13 commented Oct 15, 2024

WHY are these changes introduced?

Fixes https://github.com/Shopify/develop-advanced-edits/issues/369

There are some leftover theme commands that show a different pattern on how to call them in our dev docs. They show up as theme: command where the majority of examples refer to the commands as theme command

WHAT is this pull request doing?

Updated examples for console, push and init to use a space instead of :

How to test your changes?

You can see the updated auto-generated documents showing the changes, (README.md, oclif.manifest.json, and example scripts (.sh))
You can double check by pulling down the branch, and running npm run refresh:manifests. There should be no other changes to the generated docs.

Measuring impact

How do we know this change was effective? Please choose one:

  • n/a - this doesn't need measurement, e.g. a linting rule or a bug-fix
  • Existing analytics will cater for this addition
  • PR includes analytics changes to measure impact

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes

@EvilGenius13 EvilGenius13 requested a review from a team as a code owner October 15, 2024 17:22

This comment has been minimized.

Copy link
Contributor

github-actions bot commented Oct 15, 2024

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements
72.86% (+0.37% 🔼)
8414/11548
🟡 Branches
69.56% (+0.42% 🔼)
4140/5952
🟡 Functions
71.94% (+0.17% 🔼)
2192/3047
🟡 Lines
73.19% (+0.4% 🔼)
7957/10872
Show files with reduced coverage 🔻
St.
File Statements Branches Functions Lines
🟢
... / deploy.ts
87.18%
85% (-7.86% 🔻)
87.5% 89.19%
🟢
... / versions-list.ts
100%
85.71% (-1.79% 🔻)
100% 100%
🟢
... / admin.ts
82.76% (+1.51% 🔼)
37.5% (-2.5% 🔻)
90%
85.71% (+1.84% 🔼)

Test suite run success

1913 tests passing in 866 suites.

Report generated by 🧪jest coverage report action from 8df131c

This commit updates the syntax for theme console, init, and push.
They follow the proper pattern of theme <command>
Copy link
Contributor

@karreiro karreiro left a comment

Choose a reason for hiding this comment

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

Thank you, @EvilGenius13!

@EvilGenius13 EvilGenius13 added this pull request to the merge queue Oct 17, 2024
Merged via the queue into main with commit b5a2378 Oct 17, 2024
@EvilGenius13 EvilGenius13 deleted the fix-issue-369 branch October 17, 2024 13:47
@jamesmengo jamesmengo added the #gsd:40767 Fortify local development experience for Liquid themes label Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
#gsd:40767 Fortify local development experience for Liquid themes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants