Skip to content

Supplement image widget docs#1018

Merged
xStrom merged 39 commits intolinebender:masterfrom
covercash2:image_doc
Jun 20, 2020
Merged

Supplement image widget docs#1018
xStrom merged 39 commits intolinebender:masterfrom
covercash2:image_doc

Conversation

@covercash2
Copy link
Contributor

this is mostly just a description of the existing API with a note about the "image" feature and more links.

covercash2 added 12 commits June 1, 2020 12:12
The idea is to work toward a more robust image widget.
Documentation is just the first step.
By reducing the scope of the "image" feature, we can
expose the bare-bones image widget API and better
document the "image" feature.
This should make the feature more discoverable
and make it clearer why it is optional.
@xStrom xStrom added docs concerns documentation S-needs-review waits for review labels Jun 4, 2020
Copy link
Member

@xStrom xStrom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on improving the docs!

I made some inline comments how we can polish this even further.

Comment on lines +33 to +34
/// Note: interpolation can lead to blurry or pixelated images and so is not
/// recommended for things like icons. Instead consider using
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can lead to when? With DPI scaling? Should mention just briefly that when scaling.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'm not sure exactly how DPI scaling is relevant here? like images may look fine on a normal DPI screen but blurry when in hiDPI situations?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

exactly, yea.

@xStrom xStrom added S-waiting-on-author waits for changes from the submitter and removed S-needs-review waits for review labels Jun 5, 2020
@xStrom xStrom added S-needs-review waits for review S-waiting-on-author waits for changes from the submitter and removed S-waiting-on-author waits for changes from the submitter S-needs-review waits for review labels Jun 16, 2020
The idea is to work toward a more robust image widget.
Documentation is just the first step.
This should make the feature more discoverable
and make it clearer why it is optional.
Copy link
Member

@xStrom xStrom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for letting this sit so long. Thanks for putting in the effort!

@xStrom xStrom removed the S-waiting-on-author waits for changes from the submitter label Jun 20, 2020
@xStrom xStrom merged commit d6f8239 into linebender:master Jun 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs concerns documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants