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

Typo in description of incompatible changes #539

Closed
dalv666 opened this issue May 7, 2024 · 2 comments · Fixed by #542
Closed

Typo in description of incompatible changes #539

dalv666 opened this issue May 7, 2024 · 2 comments · Fixed by #542
Labels
bug Something isn't working

Comments

@dalv666
Copy link

dalv666 commented May 7, 2024

[changing an existing header param to enum is breaking](checker/check_breaking_property_test.go?plain=1#L185)

Typo. The test checks that the path variable has become an enum and not in the header. For the header, there is a separate test.

Similarly:

// BC: changing an existing header param to enum is breaking

Solution:
[changing an existing path param to enum is breaking](https://github.com/Tufin/oasdiff/blob/b89acea39d422cddd1c6879850cbfc603d73aa0a/checker/check_breaking_property_test.go?plain=1#L185)

@dalv666 dalv666 added the bug Something isn't working label May 7, 2024
@reuvenharrison reuvenharrison linked a pull request May 12, 2024 that will close this issue
@reuvenharrison
Copy link
Collaborator

Hi @dalv666 ,
Could you please share the use case: how are you using the test descriptions?
Thanks,
Reuven

@dalv666
Copy link
Author

dalv666 commented May 13, 2024

The description of backwards incompatible is not clearly described, so you have to determine what this means from the source code. The description helps you find the test using text search. Otherwise it would be more reliable to search for the code by identifier. Yes, this can be done by link in description, but it does not work in IDE.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants