Skip to content

Ensure docstring comment names are set correctly #1457

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
Merged
jamietanna merged 1 commit into from
Feb 10, 2024
Merged

Ensure docstring comment names are set correctly #1457

jamietanna merged 1 commit into from
Feb 10, 2024

Conversation

@ConorPKeegan
Copy link
Contributor

@ConorPKeegan ConorPKeegan commented Feb 8, 2024

This PR ensures that the docstring comment names are set using x-go-name so that they actually match the Go name.

Currently, it would generate this as shown in the test:

// ReferenceToRenameMe When a Schema is renamed, $ref should refer to the new name
 type ReferenceToRenameMe struct {
        // ToNewName This schema should be renamed via x-go-name when generating
        NewName NewName `json:"ToNewName"`
 }

Whereas, it should instead show this:

// ReferenceToRenameMe When a Schema is renamed, $ref should refer to the new name
 type ReferenceToRenameMe struct {
        // NewName This schema should be renamed via x-go-name when generating
        NewName NewName `json:"ToNewName"`
 }

@jamietanna jamietanna added the bug Something isn't working label Feb 10, 2024
jamietanna
jamietanna approved these changes Feb 10, 2024
View reviewed changes
Copy link
Member

@jamietanna jamietanna left a comment

Choose a reason for hiding this comment

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

Thanks very much!

@jamietanna jamietanna merged commit 327e62e into oapi-codegen:master Feb 10, 2024
danicc097 pushed a commit to danicc097/oapi-codegen that referenced this pull request Aug 31, 2024
@ConorPKeegan @danicc097
Fix: Render Go Doc correctly with x-go-name (oapi-codegen#1457)
500438e 
Right now, prefixes to Go Doc strings use the generated type name, not
the name that's overridden by the `x-go-name` extension.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jamietanna jamietanna jamietanna approved these changes

Assignees

No one assigned

Labels

bug Something isn't working

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ConorPKeegan @jamietanna