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.

Sign up for GitHub

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

Jump to bottom

Fix documentation reference when methods are too close #2806

Merged
merged 4 commits into from
Nov 18, 2024
Merged

Fix documentation reference when methods are too close #2806

merged 4 commits into from
Nov 18, 2024
+41 −3

Conversation

IgnacioFan
Copy link
Contributor

@IgnacioFan IgnacioFan commented Oct 30, 2024 •
edited
Loading

Motivation

Closes #2786

Fix incorrect documentation references when methods are too close.

Implementation

Add comment_exists_at? to check for a comment at the start_line. If there is, it returns true. Otherwise, it returns false (there is no comment at the start_line, and it's an empty line).

Automated Tests

Add a new test

@IgnacioFan
delete line key from @comments_by_line when comment has been visited

Partially verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
We cannot verify signatures from co-authors, and some of the co-authors attributed to this commit require their commits to be signed.
Loading
Loading status checks…
fca7dc6
@IgnacioFan IgnacioFan requested a review from a team as a code owner October 30, 2024 20:24
@IgnacioFan
Copy link
Contributor Author

IgnacioFan commented Oct 30, 2024 •
edited
Loading

I found a test failed because I did @comments_by_line.delete(line). 🤔🤔

image

vinistock
vinistock reviewed Nov 1, 2024
View reviewed changes
Copy link
Member

@vinistock vinistock left a comment

Choose a reason for hiding this comment

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

Looking good, but we can simplify the fix.

@vinistock vinistock added bugfix This PR will fix an existing bug server This pull request should be included in the server gem's release notes labels Nov 1, 2024
@IgnacioFan
fix 'test_completion_resolve_with_owner_present' test

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
Learn about vigilant mode
Loading
Loading status checks…
fd2dc73
@IgnacioFan
add source_lines and refactor collect_comments

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
Learn about vigilant mode
Loading
Loading status checks…
0e13222
@IgnacioFan
minimize the changes

Partially verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
We cannot verify signatures from co-authors, and some of the co-authors attributed to this commit require their commits to be signed.
Loading
Loading status checks…
b4caed8
vinistock
vinistock approved these changes Nov 18, 2024
View reviewed changes
Copy link
Member

@vinistock vinistock left a comment

Choose a reason for hiding this comment

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

Thank you for the contribution!

@vinistock vinistock merged commit baf6599 into Shopify:main Nov 18, 2024
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vinistock vinistock

Assignees
No one assigned
Labels
bugfix This PR will fix an existing bug server This pull request should be included in the server gem's release notes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

incorrect doc reference when methods are too close
2 participants
@IgnacioFan @vinistock