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: remove VegaConverter TODO and update misleading comment #10023

Merged
merged 1 commit into from
Oct 17, 2023

Conversation

mattseddon
Copy link
Member

@mattseddon mattseddon commented Oct 15, 2023

Thank you for the contribution - we'll try to review it as soon as possible. 🙏


Related to #9940 / #9931

This PR removes a TODO + misleading comment from the VegaConverter class. The change is already fully tested.

For context:

There is code in Studio that duplicates this logic that I will be removing. I spent a good chunk of time going between the codebases because there is contradictory information lying around.

@@ -24,6 +24,7 @@ def test_finding_lists(dictionary, expected_result):
assert list(result) == expected_result


@pytest.mark.studio
Copy link
Member Author

Choose a reason for hiding this comment

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

[F] Marking that Studio relies on this behaviour. The test is

def test_convert(
    input_data,
    properties,
    expected_datapoints,
    expected_properties,
):
    converter = VegaConverter("f", input_data, properties)
    datapoints, resolved_properties = converter.flat_datapoints("r")
    assert datapoints == expected_datapoints
    assert resolved_properties == expected_properties

@codecov
Copy link

codecov bot commented Oct 15, 2023

Codecov Report

All modified lines are covered by tests ✅

Files Coverage Δ
dvc/render/converter/vega.py 91.62% <100.00%> (ø)
tests/unit/render/test_vega_converter.py 100.00% <100.00%> (ø)

📢 Thoughts on this report? Let us know!.

@mattseddon mattseddon marked this pull request as ready for review October 15, 2023 22:57
@mattseddon mattseddon changed the title Remove VegaConverter TODO and update misleading comment plots: remove VegaConverter TODO and update misleading comment Oct 15, 2023
@dberenbaum dberenbaum enabled auto-merge (rebase) October 16, 2023 23:58
@dberenbaum dberenbaum merged commit 5f8afb9 into iterative:main Oct 17, 2023
21 checks passed
@mattseddon mattseddon deleted the remove-todo branch October 17, 2023 10:50
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 this pull request may close these issues.

None yet

3 participants