Skip to content

feat: add config options to adjust pretty doc #1485

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
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: add config options to adjust pretty doc #1485

wants to merge 2 commits into from

Conversation

@nderjung
Copy link
Contributor

@nderjung nderjung commented Jun 28, 2025 •
edited
Loading

This PR introduces two new configuration options to the standard YAML file which is included when generating Go SDKs.

These two new options can be used as such:

generator:
  # Enable or disable (enabled by default) the
  # internal pretty-doc functionality.  This takes
  # care of line-wrapping and capitalization.
  # Setting this to false uses the OpenAPI docs
  # verbatim without any modification.
  comment_pretty_doc: false

  # Set the line wrap limit.  Default is 100 and
  # setting it to -1 disables the functionality.
  # This param is ignored when pretty doc is
  # disabled.
  comment_line_limit: -1

@nderjung nderjung force-pushed the nderjung/feat/pretty-docs branch 4 times, most recently from a7103de to aa39dd6 Compare June 28, 2025 19:57
nderjung added 2 commits June 28, 2025 13:44
@nderjung
feat: add top-level comment_line_limit config option
3929a0c 
This commit introduces a new configuration option which can be
used to adjust the line width of comments.  Setting a negative
value will disable line wrapping.

Signed-off-by: Alexander Jung <[email protected]>
@nderjung
feat: add top-level comment_pretty_doc config option
ebbc82b 
This commit introduces a new configuration option which can be used
to enable or disable post-processing of the comment/description.
This is useful for providing the description as a comment verbatim.

Signed-off-by: Alexander Jung <[email protected]>
@nderjung nderjung force-pushed the nderjung/feat/pretty-docs branch from aa39dd6 to ebbc82b Compare June 28, 2025 20:45
@nderjung nderjung changed the title feat: Add config options to adjust pretty doc feat: add config options to adjust pretty doc Jun 28, 2025
ernado
ernado requested changes Sep 18, 2025
View reviewed changes
Copy link
Member

@ernado ernado left a comment

Choose a reason for hiding this comment

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

Please make the CI/CD pipeline green

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ernado ernado ernado requested changes

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@nderjung @ernado