Generate documentation for copyWith and toJson #1069
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.
Sounds like _maybeOverride should have an optional doc parameter. Otherwise LGTM
There was a problem hiding this comment.
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 |
|
Do you still wish to work on this? |
|
To be honest I totally forgot about this PR. I need to check my PR to find out what changes are still required. Might be someone else would be quicker, but I want to finish what I have started. Thank you for the reminder. |
|
@rrousselGit did I catch all the missing parts? The last time I checked the generated code everything was documented. I am not sure why I missed those. |
|
It sounds good. Do you mind refactoring the doc into a getter on |
|
@rrousselGit done |
Resolves #1068
I tried to minimize the changes. This PR also corrects the position of the
@overridefor some cases where the override was above the documentation.