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

Improve documentation of Dimensions module #13178

Closed
wants to merge 1 commit into from

Conversation

ThisIsMissEm
Copy link

@ThisIsMissEm ThisIsMissEm commented Mar 28, 2017

This includes giving a code sample and noting that window size may be different to screen size on android.

Motivation (required)

Couldn't find any documentation about the difference.

Test Plan (required)

Documentation change; But need to verify it looks right locally.

Next Steps

  • CLA is signed.
  • Need to check code style: I followed what was in Keyboard.js's documentation comments, but maybe this isn't correct?

This includes giving a code sample and noting that window size may be different to screen size on android.
@facebook-github-bot facebook-github-bot added GH Review: review-needed CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. labels Mar 28, 2017
@ThisIsMissEm
Copy link
Author

Haven't time to verify the changes work locally, but they should — cloning the repo is taking way too long on my internet connection.

*
* const screenSize = Dimensions.get('screen')
* const windowSize = Dimensions.get('window')
*

Choose a reason for hiding this comment

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

no-trailing-spaces: Trailing spaces not allowed.

*
*```
* import { Keyboard, TextInput } from 'react-native';
*

Choose a reason for hiding this comment

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

no-trailing-spaces: Trailing spaces not allowed.

@wcandillon
Copy link
Contributor

I would really like to see this merged 👍

@facebook-github-bot
Copy link
Contributor

@ThisIsMissEm I tried to find reviewers for this pull request and wanted to ping them to take another look. However, based on the blame information for the files in this pull request I couldn't find any reviewers. This sometimes happens when the files in the pull request are new or don't exist on master anymore. Is this pull request still relevant? If yes could you please rebase? In case you know who has context on this code feel free to mention them in a comment (one person is fine). Thanks for reading and hope you will continue contributing to the project.

@ThisIsMissEm
Copy link
Author

ThisIsMissEm commented Aug 17, 2017 via email

@stale
Copy link

stale bot commented Oct 16, 2017

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Maybe the issue has been fixed in a recent release, or perhaps it is not affecting a lot of people. If you think this issue should definitely remain open, please let us know why. Thank you for your contributions.

@stale stale bot added the Stale There has been a lack of activity on this issue and it may be closed soon. label Oct 16, 2017
@stale stale bot closed this Oct 23, 2017
@charpeni
Copy link
Contributor

Thank you for doing this, really useful.

I'll import this into the documentation.

@AlanSl
Copy link

AlanSl commented Sep 17, 2021

@charpeni Did this ever get imported into the documentation? The Dimensions documentation page is still rather sparse on this subject:

NAME   | TYPE           | DESCRIPTION
--     | --             | --
window | DisplayMetrics | Size of the visible Application window.
screen | DisplayMetrics | Size of the device's screen.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. Stale There has been a lack of activity on this issue and it may be closed soon.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants