This repository was archived by the owner on Mar 18, 2024. It is now read-only.
Expand C-family docstring resolution #567
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before:
After:
Summary:
Each supported language in these extensions have a set of properties attached to them (file extensions, what identifier patterns look like, what comments look like, etc). One of these properties is
docstringIgnore, which will allow us to ignore the lines between where a ctags definition occurs and the comment that is meant to belong to it. Until now, all we've used this for is for Java-style annotations, e.g.This adds support for the C-family convention of breaking definitions up onto multiple lines:
This could have unintended side-effects where comments that do not belong to a ctags definition just happens to be close enough to it, but I think it's an acceptable risk tradeoff (while hand-testing I couldn't get it to do something worse than the previous behavior).
Fixes https://github.com/sourcegraph/sourcegraph/issues/17925.