Unknown tag `doc`

[stijns96]

This is already supported by theme-tools, but the CLI gives me the following error

error
│ snippets/get-schedule-markets.liquid
│ Liquid syntax error (line 1): Unknown tag 'doc'

I assume that this is due to the CLI, but do we know when this will be supported as well?

[jamesmengo]

Hey @stijns96!

We've shipped tooling support for LiquidDoc, but this feature isn't live on the platform side yet so you won't be able to save any doc tags to your theme until we roll this out across the platform.

We're currently waiting for a couple of final pieces and are targeting a release date of March 19, though that is subject to change.

Keep an eye out on any changelogs published here! We'll also announce this in slack and will have docs available on shopify.dev at https://shopify.dev/docs/storefronts/themes/tools :)

[stijns96]

Hi @jamesmengo,

It's been a while since March 19th. Any update on the timeline? Not that I'm pushing, I'm just incredibly impatient. 😂

[jamesmengo]

Don't worry, @stijns96 I am too! I can't wait for you all to get your hands on this, and I'm glad that you're excited about this!

Should be announced + rolled out by end of next week. We've had some issues on the platform side which have complicated things unfortunately.

[stijns96]

Hi @jamesmengo,

Really happy with this new feature! I do have one question and one note:

1. What about the @description attribute? I don't see it in the example in the docs. What is the preferred way?
2. LiquidDoc reference brings you to a 404. Could be part of another release, but just wanted to mention it here.

[jamesmengo]

Hey @stijns96!

Thanks for surfacing the docs issue! Those are getting rolled out today :)
That section should contain more information about the usage of @description!

@description is currently used to provide support when you hover the name of a snippet in a {% render 'snippet-name' %} context.

This feature is designed to feel similar to the JSDoc @description, so the preferred way is whatever works best for your workflow! I personally prefer an implicit description, which just means that you have to place it at top of the {% doc %} tag body before any occurrences of @

If you're not a fan of that, you can place it anywhere in the body of the tag and just append @description :)

Super glad to hear that you're already using this feature! Please do feel free to continue to reach out with feedback and suggestions :)

[montalvomiguelo]

yay! thanks guys @jamesmengo

[dhruveonmars]

Hey @jamesmengo how can we use this in a src directory, that has a nested directory structure?

We have a structure like,
snippets/cases/case-x.liquid
snippets/components/account/x.liquid

And currently, we get this issue;
"The doc tag can only be used within a snippet or block"