Skip to content

Property details pages are missing "read-only" notion #1286

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

Open
eseidelGoogle opened this issue Dec 2, 2016 · 2 comments
Open

Property details pages are missing "read-only" notion #1286

eseidelGoogle opened this issue Dec 2, 2016 · 2 comments
Labels
P2 A bug or feature request we're likely to work on type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)

Comments

@eseidelGoogle
Copy link
Contributor

For example Map.values is readonly.

Which you can see from the main Map page:
https://api.dartlang.org/stable/1.20.1/dart-core/Map-class.html

But that information is lost in the property page:
https://api.dartlang.org/stable/1.20.1/dart-core/Map/values.html

I'm not sure where the readonly comes from since I don't see it in the source:
https://github.com/dart-lang/sdk/blob/master/sdk/lib/core/map.dart#L243

@eseidelGoogle
Copy link
Contributor Author

I see, I think the readonly comes because it only has get and not set. Still, the property page should say this. :)

@sethladd sethladd added the type-bug Incorrect behavior (everything from a crash to more subtle misbehavior) label Dec 2, 2016
@jcollins-g jcollins-g added the P2 A bug or feature request we're likely to work on label Nov 17, 2017
@srawlins
Copy link
Member

srawlins commented Aug 9, 2020

This is still true today. I think that this doesn't come up frequently because setters are not nearly as common as getters. I searched the Dart SDK for a while, and finally found Counter.value. The page shows both the getter impl, and the setter impl, but very awkwardly, IMO. I think the distinction should be made more clear, especially in the case described above, where the property is "read-only."

@srawlins srawlins changed the title Property details pages are missing metadata annotations Property details pages are missing "read-only" notion Aug 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P2 A bug or feature request we're likely to work on type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)
Projects
None yet
Development

No branches or pull requests

4 participants