Copy docs to getter in Properties macro #1490
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Spurred by #1236 though there's probably more we can do here.
The change here is that we take anything that's a doc before a
#[property]
and consider that to be the docs for the getter, as it seems like the getter and the property would be the most likely to share doc comments.There is of course an open question of what one could do to get docs for the setter that aren't a pain to write, but at least for the setter we can make something that, I think, makes intuitive sense.
The big issue here is that you wouldn't get docs copied over if you add a doc to the field but after the
#[property]
. This is probably something we could allow, but I don't know how important it would be.