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

plots: meaningful section default names #1789

Merged
merged 1 commit into from
May 30, 2022
Merged

Conversation

shcheklein
Copy link
Member

@shcheklein shcheklein commented May 28, 2022

First step in #1635 . It changes sections names to be less confusing and consistent with Studio / DVC docs to:

Data Series, Images, Trends

I'm 100% sure these names are still not self-descriptive and as the next step we need to introduce tooltips.

This is still better, since having Plots section in the Plots webview was too strange. And Comparison while describes the table can be applied too all there sections - we are comparing experiments in different ways.

We can go and rename all the classes, but to be honest it's not critical and I would wait for a bit until we stabilize all this stuff.

@codeclimate
Copy link

codeclimate bot commented May 28, 2022

Code Climate has analyzed commit ddcf582 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (85% is the threshold).

This pull request will bring the total coverage in the repository to 96.7% (0.0% change).

View more on Code Climate.

@shcheklein shcheklein added product PR that affects product A: plots Area: plots webview, side panel and everything related labels May 29, 2022
@shcheklein shcheklein self-assigned this May 29, 2022
[Section.COMPARISON_TABLE]: 'Comparison'
[Section.CHECKPOINT_PLOTS]: 'Trends',
[Section.TEMPLATE_PLOTS]: 'Data Series',
[Section.COMPARISON_TABLE]: 'Images'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[F] These will only update for new users. Anyone who already has the extension installed will stick with the old names.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We only ever set them when they are undefined as we don't want to overwrite user's custom names for them:

  public getSectionName(section: Section): string {
    return this.sectionNames[section] || DEFAULT_SECTION_NAMES[section]
  }

@mattseddon mattseddon merged commit c4234bd into main May 30, 2022
@mattseddon mattseddon deleted the rename-plot-sections branch May 30, 2022 01:54
@sroy3 sroy3 mentioned this pull request Aug 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: plots Area: plots webview, side panel and everything related product PR that affects product
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants