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

Incorrect XML-doc summaries on some intent constructors #206

Closed
cosborne83 opened this issue Jan 24, 2022 · 1 comment · Fixed by #261
Closed

Incorrect XML-doc summaries on some intent constructors #206

cosborne83 opened this issue Jan 24, 2022 · 1 comment · Fixed by #261
Labels
bug Something isn't working pkg:schema-generation

Comments

@cosborne83
Copy link

Environment

  • Nuget Package: JsonSchema.Net.Generation
  • Nuget Version: 1.8.3
  • OS: Windows
  • .Net Target: .NET 6

Describe the bug

  1. The XML-doc summary for Json.Schema.Generation.Intents.DescriptionIntent constructor incorrectly states that it "Creates a new MinimumIntent instance."

See:

/// Creates a new <see cref="MinimumIntent"/> instance.

  1. The XML-doc summaries for Json.Schema.Generation.Intents.EnumIntent constructors appear to have been copied from the "Apply" method.

See:

/// Applies the keyword to the <see cref="JsonSchemaBuilder"/>.

and:
/// Applies the keyword to the <see cref="JsonSchemaBuilder"/>.

To Reproduce
Comments visible in IntelliSense when writing code to construct a new DescriptionIntent or EnumIntent.

Expected behavior
The summary should indicate that the constructor creates a new DescriptionIntent or EnumIntent instance per summaries on other Intent constructors.

@cosborne83 cosborne83 added the bug Something isn't working label Jan 24, 2022
@gregsdennis
Copy link
Owner

Thanks for reporting these. I'm working on a 2.0 of this library, and I'll try to review these comments before publish.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working pkg:schema-generation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants