-
-
Notifications
You must be signed in to change notification settings - Fork 226
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
Generate documentation for copyWith and toJson #1069
base: master
Are you sure you want to change the base?
Conversation
|
@rrousselGit I noticed that you merged a dependabot PR, so you are working today. Is there anything in my PR I should change? |
return _maybeOverride( | ||
''' | ||
@JsonKey(ignore: true) | ||
return ''' |
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.
Sounds like _maybeOverride should have an optional doc
parameter. Otherwise LGTM
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.
There appear to be a few missing places with regards to copyWith documentation.
We need to document the call
method of the object returned by get copyWith
.
This will provide doc when writing copyWith(...)
.
Currently docs appear with .copyWith
, but not .copyWiht(...)
We also will want doc for deep copy, such as value.copyWith.field(...)
Sorry I forgot this comment. I'll check that this weekend |
Resolves #1068
I tried to minimize the changes. This PR also corrects the position of the
@override
for some cases where the override was above the documentation.