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

Update ScatterPlotViewer README #6122

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

lcjohnso
Copy link
Member

@lcjohnso lcjohnso commented Jun 5, 2024

Describe your changes

Updates out-of-date documentation for the ScatterPlotViewer to clarify that all coordinate data should be passed using seriesData structure, not just in the case of wanting to support multiple series. The updates also clarify differences between the PH TESS LightCurveViewer (e.g., assumed subject media and JSON data formatting) and point to that viewer's README for viewer-specific details.

Package

lib-classifier

Linked Issue and/or Talk Post

Closes #6118

How to Review

Checklist

PR Creator - Please cater the checklist to fit the review needed for your code changes.
PR Reviewer - Use the checklist during your review. Each point should be checkmarked or discussed before PR approval.

General

  • Tests are passing locally and on Github
  • Documentation is up to date and changelog has been updated if appropriate
  • You can yarn panic && yarn bootstrap or docker-compose up --build and FEM works as expected

@lcjohnso lcjohnso added the documentation Add the documentation for something label Jun 5, 2024
@coveralls
Copy link

Coverage Status

coverage: 80.432% (+0.03%) from 80.398%
when pulling 32eacce on edit-scatterplot-readme
into d89db9a on master.

@eatyourgreens
Copy link
Contributor

There’s also issue #5324, since the TESS light curve viewer is technical debt at this point, and TESS subjects can be displayed in the scatter plot viewer.

@goplayoutside3
Copy link
Contributor

@lcjohnso what's the status of this PR? Would you still like it reviewed? Should it wait until Shaun is back from OOO to review it?

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

Successfully merging this pull request may close these issues.

Issue with Json data charts Preview
4 participants