Skip to content
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

[REQ] [Dart] instructions in generated README are problematic #3641

Closed
nickmeinhold opened this issue Aug 14, 2019 · 2 comments · Fixed by #3809
Closed

[REQ] [Dart] instructions in generated README are problematic #3641

nickmeinhold opened this issue Aug 14, 2019 · 2 comments · Fixed by #3809

Comments

@nickmeinhold
Copy link
Contributor

Is your feature request related to a problem? Please describe.

I spoke to someone today who was having issues trying to use a generated client as the README instructions are a bit confusing and incorrectly use a mapping value.

The generated README includes instructions like this:

If this Dart package is published to Github, please include the following in pubspec.yaml

name: api_client
version: 0.0.1
description: OpenAPI API client
dependencies:
  api_client:
    git: https://github.com/username/api_client.git
      version: 'any'

Describe the solution you'd like

Get rid of the first 3 three lines and the last line and change the wording a little so the instructions are:

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  api_client:
    git: https://github.com/username/api_client.git
@nickmeinhold
Copy link
Contributor Author

Also the Requirements in the generated README are

Dart 1.20.0 or later OR Flutter 0.0.20 or later

and I believe should be

Dart 2.0 or later

I might rename this issue to something more general like "generated README needs updating" and go through more thoroughly and see if there is anything else I think should be changed. Is it preferred to group together small changes like this?

@wing328
Copy link
Member

wing328 commented Aug 14, 2019

Agreed if supportDart2 is set to true, the requirement should be Dart 2.0 or later.

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

Successfully merging a pull request may close this issue.

2 participants