-
-
Notifications
You must be signed in to change notification settings - Fork 6.7k
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
Improve generation of README which has long description #400
Conversation
* @param input String to be escaped | ||
* @return escaped string | ||
*/ | ||
public String escapeTextWhileAllowingNewLines(String input) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
almost duplicated with escapeText
. Please let me know if you know better idea. 💦
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Technically we can add another parameter to escapeText
(similar to camelize
) but that probably will require code updates in lots of places.
Let's go with this solution for the time being.
@OpenAPITools/generator-core-team |
I think my attempt to resolve the conflict online (using Github web-based GUI) introduces some issues. I'll fix it locally and push out a fix soon. |
Thanks for resolving the conflicts! I noticed that I missed the case of empty description. 👀 I'll push a commit soon. |
Not related to this PR, but there's the diffs on results of so ran the script locally and pushed commit. |
…#400) * Add `appDescriptionWithNewLines` * Add test case for escapeText as well * Ruby client allows new lines in README * Add doc comment * fix issue related to github web gui * the case of no description provided * Run `./bin/utils/ensure-up-to-date` https://app.shippable.com/github/OpenAPITools/openapi-generator/runs/1118/1/console
PR checklist
./bin/
to update Petstore sample so that CIs can verify the change. (For instance, only need to run./bin/{LANG}-petstore.sh
and./bin/security/{LANG}-petstore.sh
if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in.\bin\windows\
.master
,3.1.x
,4.0.x
. Default:master
.Description of the PR
issue: #369
Added
{{appDescriptionWithNewLines}}
tag which allows new lines.