docs: provide a better formatting for README #4930
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Provided a better formatting for the README
There was a problem hiding this comment.
Pull Request Overview
A concise formatting update for the plugin README, standardizing list items and removing a duplicate parameter entry
- Reformatted the “Since version” list to proper markdown bullets
- Removed the duplicated
defaultResponseCodeentry
Comments suppressed due to low confidence (2)
modules/swagger-gradle-plugin/README.md:126
- Remove the leading indent (4 spaces) before the list items so that the markdown bullets render properly instead of being treated as code blocks.
- Since version 2.1.6, `sortOutput` parameter is available, allowing to sort object properties and map keys alphabetically.
modules/swagger-gradle-plugin/README.md:127
- [nitpick] Add a period at the end of this bullet for consistency and consider rephrasing to 'Since version 2.1.6,
objectMapperProcessorClassalso allows configuring the ObjectMapper instance used to serialize the resolved OpenAPI.' for clarity.
- Since version 2.1.6, `objectMapperProcessorClass` allows to configure also the ObjectMapper instance used to serialize the resolved OpenAPI
daniel-kmiecik
approved these changes
Jul 16, 2025
|
@lfgcampos thank you for your contribution! We will add this to the next release. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before:
After:
