[LiquidDoc] Prevent rendering of hover tooltip for snippets with no renderable content

[jamesmengo]

What are you adding in this PR?

{% render 'snippet' %}

Prevents rendering hover tooltip for snippets that:

• do not exist
• do not have renderable content.

Renderable content: Currently, this means that it requires a LiquidDoc definition with @param annotations, though this will soon expand to the description and @example as well

Before you deploy

• This PR includes a new checks or changes the configuration of a check
  • I included a minor bump changeset
  • It's in the allChecks array in src/checks/index.ts
  • I ran yarn build and committed the updated configuration files
    • If applicable, I've updated the theme-app-extension.yml config

• I included a minor bump changeset
• My feature is backward compatible

• I included a patch bump changeset

[jamesmengo]

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

• [LiquidDoc] Hover: Wrap optional parameter names in [] #735
• [LiquidDoc] Formatting support for optional @param delimiters [] #734
• [LiquidDoc] Parser support for optional parameters #733
• [LiquidDoc] Prevent rendering of hover tooltip for snippets with no renderable content #729 👈 (View in Graphite)
• [LiquidDoc] Add snippet hover support inside of {% render %} tag #703 : 2 other dependent PRs (#719 , #726 )
• Add parsing + prettier support for @param in {% doc %} tags #646 : 3 other dependent PRs (#652 , #665 , #691 )
• Add basic {% doc %} tag parsing support #621 : 2 other dependent PRs (#636 , #638 )
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[jamesmengo]

@charlespwd Branching off of this comment for snippets without a liquidDoc definition, what is some valuable content we can render here?

Is there value in rendering the below?

[charlespwd]

I mean... your opinion is as good as mine? Maybe would be better to add something that points to the snippet file in the description?

Ideally we'd be able to differentiate between something that exists vs something that does not exist. But there's the theme check for that so 🤷

[jamesmengo]

Snippet exists, but no liquidDoc

Snippet does not exist

• Renders a red squiggly + warning via theme check