Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor error in Perspective Viewer API documentation #1004

Closed
abircb opened this issue Apr 6, 2020 · 0 comments
Closed

Minor error in Perspective Viewer API documentation #1004

abircb opened this issue Apr 6, 2020 · 0 comments

Comments

@abircb
Copy link

abircb commented Apr 6, 2020

Bug Report (Documentation Error)

🏷 documentation

Steps to Reproduce:

  1. Go here: https://github.com/finos/perspective/tree/master/packages/perspective-viewer#module_perspective-viewer..PerspectiveViewer+sort
  2. Look at line-2 of the Example (via JavaScript DOM)

Expected Result:

let elem = document.getElementById('my_viewer');
elem.setAttribute('sort', JSON.stringify([["x","desc"]]));

Actual Result:

While reading (and learning from) the perspective-viewer documentation, I came across a minor typo.

let elem = document.getElementById('my_viewer');
elem.setAttribute('sort', JSON.stringify([["x","desc"]));

The JSON.stringify() function's argument is missing a small, yet vital, closed square bracket - "]". Copying-and-pasting this code fragment leads to a compilation error for the user.

Environment:

N/A

Additional Context:

N/A

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant