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

vdoc: fix regression on example comments #21226

Merged
merged 5 commits into from
Apr 12, 2024

Conversation

ttytm
Copy link
Member

@ttytm ttytm commented Apr 8, 2024

Fix for a regression that happend due to accidentally leaving merge methods changed when working #21220. The symptom is that examples are part of the comment text
Screenshot_20240408_160452

Adds tests for doc comment examples. The main coverage here is that there are no duplicates in of the example comments.

@ttytm ttytm force-pushed the vdoc/fix-example-regression branch from 416dc03 to 8bd5b2b Compare April 8, 2024 15:53
@ttytm
Copy link
Member Author

ttytm commented Apr 9, 2024

@spytheman Would the CI failure here resolve itself after a rebase/merge?

@spytheman
Copy link
Member

@spytheman Would the CI failure here resolve itself after a rebase/merge?

Not sure, I do not understand why it failed in the first place, since I do not see anything platform specific in the change here.

Lets rebase it, and see if it will repeat.

@ttytm ttytm force-pushed the vdoc/fix-example-regression branch from 8bd5b2b to 88714e7 Compare April 11, 2024 14:54
This reverts commit d9931e1.
@ttytm
Copy link
Member Author

ttytm commented Apr 11, 2024

The tests for the example output is still problematic with Ubuntu Docker MUSL CI.

If thats okay not adding the test here and just restoring the correct behaviour then lets do it. It's a simple change that can get a little of coverage due to it's blame history.

@ttytm ttytm changed the title vdoc: fix regression on example comments, add test vdoc: fix regression on example comments Apr 11, 2024
@spytheman spytheman merged commit b443613 into vlang:master Apr 12, 2024
44 checks passed
@ttytm ttytm deleted the vdoc/fix-example-regression branch April 12, 2024 08:52
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.

2 participants