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

see in XML comment causes invalid schema description #4070

Closed
tobias-tengler opened this issue Aug 11, 2021 · 1 comment
Closed

see in XML comment causes invalid schema description #4070

tobias-tengler opened this issue Aug 11, 2021 · 1 comment
Labels
🐛 bug Something isn't working 🙋 good first issue Good for newcomers 🌶️ hot chocolate ⌛ stale Nothing happened with this issue in quite a while
Milestone

Comments

@tobias-tengler
Copy link
Collaborator

Using see also seems to have some strange behaviour if it references a method (possibly a bug, or just an unhandled situation?).

If I have a mutation:

public async Task<TestMutationPayload> TestMutation(TestMutationInput input)
{
    ...

With the input object defined as:

/// <summary>
/// Input object for <see cref="TestMutations.TestMutation"/>.
/// </summary>
public class TestMutationInput
{
    ...

Then this appears in the SDL as:

"""
Input object for TestMutationInput).
"""
input TestMutationInput {
  ...

The comment always seems to reference the object type of the last parameter to the mutation, followed by an ending bracket.

Ideally this would instead be output as:

"""
Input object for TestMutation.
"""
input TestMutationInput {
  ...

Originally posted by @cjzzz in #3730 (comment)

@tobias-tengler tobias-tengler changed the title Using see seems to have some strange behaviour if it references a method (possibly a bug, or just an unhandled situation?). see in XML comment causes invalid schema description Aug 11, 2021
@michaelstaib michaelstaib added this to the Backlog milestone Nov 22, 2021
@PascalSenn PascalSenn added the 🙋 good first issue Good for newcomers label Mar 16, 2022
@stale
Copy link

stale bot commented May 15, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the ⌛ stale Nothing happened with this issue in quite a while label May 15, 2022
@stale stale bot closed this as completed May 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛 bug Something isn't working 🙋 good first issue Good for newcomers 🌶️ hot chocolate ⌛ stale Nothing happened with this issue in quite a while
Projects
None yet
Development

No branches or pull requests

3 participants