-
-
Notifications
You must be signed in to change notification settings - Fork 7.3k
[dart][dart-dio] Update docs for dart-dio-next #9584
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
Conversation
* remove deprecated author field from all pubspec templates * improve dart-dio-next readme/markdown documentation * add a lot of dart-doc to model and API classes
...api3/client/petstore/dart-dio-next/petstore_client_lib_fake/doc/AdditionalPropertiesClass.md
Show resolved
Hide resolved
| description: {{pubDescription}} | ||
| homepage: {{pubHomepage}} | ||
| authors: | ||
| - '{{{pubAuthor}}} <{{{pubAuthorEmail}}}>' |
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.
someone recently added this. why removing it?
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.
This is deprecated: https://dart.dev/tools/pub/pubspec#authorauthors
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.
I can leave it for the old generators but definitely removing it for dart-dio-next.
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.
oh didnt know that, funny someone added this in the last month or two
| ```dart | ||
| import 'package:openapi/api.dart'; | ||
| var api_instance = new StoreApi(); |
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.
I feel a bit cheated with name of this PR. these changed dont belong here imo.
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.
Can you elaborate? The existing samples have been wrong from the first day.
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.
These are sample code snippets in markdown files in case you missed that :o
PR checklist
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.For Windows users, please run the script in Git BASH.
master,5.1.x,6.0.xCC @swipesight (2018/09) @jaumard (2018/09) @josh-burton (2019/12) @amondnet (2019/12) @sbu-WBT (2020/12) @kuhnroyal (2020/12) @agilob (2020/12)