Skip to content
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

chore(docs): Update missing default resources for Android #689 #291

Merged
merged 1 commit into from
Oct 19, 2020

Conversation

distante
Copy link
Contributor

Disclaimer: This is an almost 1 to 1 copy of 228 that was closed on a technicality

Platforms affected

Only docs

Motivation and Context

Current documentation lacks the default resources for Android.
On Android, you can provide alternative resources for specific device configuration, like current docs provide alternative resources for portrait and landscape orientation. But error will be thrown if a device configuration does not match any specific alternative resources, so you should provide a default (In this case, without port- or land- ) as a fallback.
This change fixes the error reported in #185 and apache/cordova-android#689.

Description

Although orientation is only portrait and landscape as of now, providing default would prevent MissingDefaultResource lint check error and considered as good practice for Android resources configuration.

Likewise, if you provide different layout resources based on the screen orientation, you should pick one orientation as your default. For example, instead of providing layout resources in layout-land/ for landscape and layout-port/ for portrait, leave one as the default, such as layout/ for landscape and layout-port/ for portrait.

Note:
You don’t have to provide a default for screen density. The system use whichever resources are the best match.

Testing

Checklist

  • I've run the tests to see all new and existing tests pass
  • I added automated test coverage as appropriate for this change
  • Commit is prefixed with (platform) if this change only applies to one platform (e.g. (android))
  • If this Pull Request resolves an issue, I linked to the issue in the text above (and used the correct keyword to close issues using keywords)
  • I've updated the documentation if necessary

Copy link
Contributor

@breautek breautek left a comment

Choose a reason for hiding this comment

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

lgtm

@breautek breautek requested review from erisu and timbru31 October 17, 2020 17:01
@distante
Copy link
Contributor Author

I do not know why it is failing with Travis :S

@timbru31
Copy link
Member

The Travis failures are unrelated and can be ignored for this PR.

@breautek breautek merged commit 6425495 into apache:master Oct 19, 2020
@breautek
Copy link
Contributor

Thank you @distante for your effort in preparing this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants