defineSliceZoneComponents jsdoc @example isn't formatted nicely
danielphilipjohnson opened this issue · comments
Versions
- @prismicio/vue: 3.1.0
Reproduction
Hovering over defineSliceZoneComponents the code isn't formatted and a little hard to read
Additional Details
Steps to reproduce
Refer to above
What is expected?
To format nicely
What is actually happening?
Spacing isn't observed
Fix
This line will stop jsdoc from formatting the line
@example Defining a slice components:
A Possible solution is to move this to a @description Defining a slice components. However, the linting tool formats it the following way 👀
After the change It now appears like this:
All nicely formatted 😄
This issue has been labeled as a bug since it was created using the 🚨 Bug Report Template.
Hi there, thank you so much for the report!
Following our Maintenance Process, we will review your bug report and get back to you next Wednesday. To ensure a smooth review of your issue and avoid unnecessary delays, please make sure your issue includes the following:
- Information about your environment and packages you use (Node.js version, package names and their versions, etc.)
Feel free to attach a copy of yourpackage.jsonfile. - Any troubleshooting steps you already went through
- A minimal reproduction of the issue, and/or instructions on how to reproduce it
If you have identified the cause of the bug described in your report and know how to fix it, you're more than welcome to open a pull request addressing it. Check out our quick start guide for a simple contribution process.
If you think your issue is a question (not a bug) and would like quicker support, please close this issue and forward it to an appropriate section on our community forum: https://community.prismic.io
- The Prismic Open-Source Team
Hey Daniel,
Thanks for opening this issue and PR and sorry for the delay - as I think you know I was away these last weeks.
I'm not sure about the @description tag as it doesn't appear to be part of the TSDoc spec: https://tsdoc.org/pages/tags/example (or maybe I'm missing something, but it is part of the JSDoc spec indeed)
I'll follow up in the PR :)