bloomreach / bloomreach/docs-feedback

APIdocs and syntactically correct Javascript would help a lot

Open
#51 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.