search

bloomreach / docs-feedback

1 stars 0 forks source link

APIdocs and syntactically correct Javascript would help a lot #51

Open aredridel opened 3 years ago

aredridel commented 3 years ago

https://documentation.bloomreach.com/search-and-merchandising/docs/milestone-2.-pixel-deployment/page-view-pixels/global-view-pixel.html

On this page, many of the examples don't parse, and the ways they don't are ambiguous what the user should be providing.

Using proper APIdoc formats — say jsdoc — would be a lot less ambiguous. It's always hard to tell what is a string, what's not, what should be quoted, what should not.

brpliao commented 3 years ago

Thanks for your feedback @aredridel , we will look into improving the examples.