Skip to content

Documentation fixes#13

Merged
look merged 2 commits intogithub:mainfrom
314eter:documentation-fixes
Jan 14, 2025
Merged

Documentation fixes#13
look merged 2 commits intogithub:mainfrom
314eter:documentation-fixes

Conversation

@314eter
Copy link
Copy Markdown
Contributor

@314eter 314eter commented Jan 11, 2025

Method seems to be missing from the supported definitions. Since it's used in the fully-qualified names example, I assume it's supported?

I have some other questions:

  1. The documentation only mentions @reference.call. Does that mean other references are not supported, or does the support for e.g. @definition.module imply that @reference.module is supported too? If that's the case, is @reference.function supported, or does it have to be @reference.call?
  2. The fully-qualified names example uses @definition.class as container. Can all definitions (class/module/function/...) be used as containers?
  3. In the fully-qualified Java example the separator is ::, in the Go example it's .. Should the separator be defined somewhere? Can it be different for different types of containers?
  4. How do references to fully-qualified names work? Should the @name in the reference contain the fully-qualified name? Or can references use the non-qualified name?

@314eter 314eter requested a review from a team as a code owner January 11, 2025 22:05
@tclem tclem requested a review from look January 13, 2025 14:59
Copy link
Copy Markdown
Member

@look look 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 fixing the tree-sitter link and the contribution. The omission of @definition.method was an oversight.

I'll try to briefly answer your other questions below, but if you have further questions, please open issues for them so we can track that. Thanks!

  1. The documentation only mentions @reference.call. Does that mean other references are not supported, or does the support for e.g. @definition.module imply that @reference.module is supported too? If that's the case, is @reference.function supported, or does it have to be @reference.call?

The system only supports @reference.call right now.

  1. The fully-qualified names example uses @definition.class as container. Can all definitions (class/module/function/...) be used as containers?

Offhand, I don't know that we have any examples using this, but I reviewed the code and it should support containers of class, enum, implementation, interface, struct, type, trait, union, and module.

  1. In the fully-qualified Java example the separator is ::, in the Go example it's .. Should the separator be defined somewhere? Can it be different for different types of containers?

It's defined per-language when we wire up the language parser with its query. It can't vary by container at this time.

  1. How do references to fully-qualified names work? Should the @name in the reference contain the fully-qualified name? Or can references use the non-qualified name?

You can use either (or, additionally, a regex). Using the fully-qualified name will give you more precise results.

There's some examples of using the symbol: qualifier in the documentation: https://docs.github.com/en/search-github/github-code-search/understanding-github-code-search-syntax#symbol-qualifier

@look look merged commit d9ec12d into github:main Jan 14, 2025
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