Skip to content

Improve generation of README which has long description - #400

Merged
wing328 merged 8 commits into
OpenAPITools:masterfrom
ackintosh:issue-369
Jul 3, 2018
Merged

Improve generation of README which has long description#400
wing328 merged 8 commits into
OpenAPITools:masterfrom
ackintosh:issue-369

Conversation

@ackintosh

@ackintosh ackintosh commented Jun 26, 2018

Copy link
Copy Markdown
Contributor

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./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\.
  • Filed the PR against the correct branch: master, 3.1.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

issue: #369

Added {{appDescriptionWithNewLines}} tag which allows new lines.

* @param input String to be escaped
* @return escaped string
*/
public String escapeTextWhileAllowingNewLines(String input) {

@ackintosh ackintosh Jun 26, 2018

Copy link
Copy Markdown
Contributor Author

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. 💦

Copy link
Copy Markdown
Member

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.

@ackintosh

Copy link
Copy Markdown
Contributor Author

@OpenAPITools/generator-core-team

@wing328 wing328 added this to the 3.1.0 milestone Jul 1, 2018
@wing328

wing328 commented Jul 1, 2018

Copy link
Copy Markdown
Member

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.

@ackintosh

Copy link
Copy Markdown
Contributor Author

Thanks for resolving the conflicts!

I noticed that I missed the case of empty description. 👀 I'll push a commit soon.

@ackintosh

Copy link
Copy Markdown
Contributor Author

Not related to this PR, but there's the diffs on results of ./bin/utils/ensure-up-to-date.
Shippable status: https://app.shippable.com/github/OpenAPITools/openapi-generator/runs/1118/1/console

so ran the script locally and pushed commit.

@wing328
wing328 merged commit 0137763 into OpenAPITools:master Jul 3, 2018
@ackintosh
ackintosh deleted the issue-369 branch July 4, 2018 04:31
A-Joshi pushed a commit to ihsmarkitoss/openapi-generator that referenced this pull request Feb 27, 2019
…#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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants